Commit Graph

111 Commits

Author SHA1 Message Date
Simon Michael
5435150d39 doc: don't use sed; fix accidental dedenting of some lists (#961)
The sed code was showing an error message, not too precise.
Pandoc's lua filters to the rescue!

[ci skip]
2019-01-31 08:34:49 -08:00
Simon Michael
c8246e7323 cli: command help: reduce width, line wrapping
cmdargs wraps any lines longer than 78 characters.  To (mostly) avoid
this, we now display verbatim blocks unindented, and some of
register's examples have been altered to make them fit.
2019-01-30 17:58:13 -08:00
Simon Michael
fa996828b1 shake: fix build's doc deps; cleanup
[ci skip]
2019-01-30 12:45:09 -08:00
Simon Michael
4c5ac4dd06 cli: fix command help, really render as plain text
pandoc thinks .txt is a markdown file apparently
2019-01-30 12:44:10 -08:00
Simon Michael
0628b648f3 shake: Shake PKG (or Shake build) builds packages plus their docs
"stack build hledger" will not notice changes in documentation source
files (like hledger/Hledger/Cli/Commands/Add.md or
hledger-lib/hledger_journal.m4.md), but "./Shake hledger" will.

"./Shake build" builds all the packages, like a doc-aware "stack build".
2019-01-30 10:41:39 -08:00
Simon Michael
5b6c441698 shake: manuals: also depend on new command doc files 2019-01-26 16:33:35 -08:00
Simon Michael
789e8be280 shake: update required tools list
[ci skip]
2019-01-25 07:04:16 -08:00
Simon Michael
eac15369f2 doc: stop pandoc typography conversions in html manuals (#954)
Eg: -- was being rendered as en-dash.

[ci skip]
2019-01-24 15:29:56 -08:00
Simon Michael
5c5e404df6 doc: contributing: add TOC 2019-01-19 17:31:03 -08:00
Simon Michael
d095e6a06b shake: also clean the copied README/CONTRIBUTING
[ci skip]
2019-01-19 15:47:39 -08:00
Simon Michael
5000c6ac6a site: forcing lower-case URIs is a hassle; add redirects for now
[ci skip]
2019-01-19 15:42:43 -08:00
Simon Michael
240406706a move the wiki dev docs into CONTRIBUTING.md. Markdown for now. #920
[ci skip]
2019-01-19 15:31:21 -08:00
Simon Michael
9f057731c3 shake: common pandoc opts
[ci skip]
2019-01-19 15:31:21 -08:00
Simon Michael
b7e64440b2 shake: cleanups, document
[ci skip]
2019-01-19 15:31:21 -08:00
Simon Michael
1077ccf70c shake: cleanups
[ci skip]
2019-01-19 15:31:21 -08:00
Simon Michael
ef0f4cd4d2 shake: disable pandoc's tex math extension to silence relnote warning
[ci skip]
2018-12-03 09:21:05 -08:00
Simon Michael
67d7c82e9f bump version to 1.12 2018-12-02 17:20:34 -08:00
Simon Michael
e6556e4760 site: shake: also generate the 1.11 web manual
[ci skip]
2018-10-06 09:48:03 -10:00
Simon Michael
7f1b34ea1d doc: fix generation of 1.10 manual html 2018-07-04 13:22:09 +01:00
Everett Hildenbrandt
615ca04813 Shake.hs: use system-wide install of pandoc instead of stack exec pandoc 2018-05-21 08:35:49 -07:00
Everett Hildenbrandt
16200908e8 Shake, tools/pandoc-site.{hs => lua}: switch to building site with Lua filter 2018-05-21 08:35:49 -07:00
Everett Hildenbrandt
946fa1d498 tools/pandoc-{site,drop-toc}, Shake, site/, doc/: switch from bulletlist to metainline toc marker
Files `site/doc/{1.0,1.1}/hledger-ui.md` had to be treated specially because
thay had some other elements inside the same `BulletList` that the `toc` lived
inside. Because only the first element of the `BulletList` is compared, these
extra HTML elements were either dropped or replaced with a TOC at compile time.
By switching to the meta-inline `\$toc\$`, they started to persist into the
resulting HTML. The fix was to drop them from the source markdown.
2018-05-21 08:35:49 -07:00
Everett Hildenbrandt
e8ac237752 Shake.hs, stack-ghc8.2.yaml: missing extra-dep for pandoc 2018-05-21 08:35:49 -07:00
Simon Michael
fe7157dfa4 tools: remove some more hakyll-std traces
[ci skip]
2018-05-09 10:20:21 -07:00
Everett Hildenbrandt
2618455ab9 Shake.hs: organize 2018-05-09 10:13:02 -07:00
Everett Hildenbrandt
1a909fe2a3 Shake.hs, site/hakyll-std: remove mentions/dependencies of hakyll-std 2018-05-09 10:13:02 -07:00
Everett Hildenbrandt
567a86b810 Shake.hs, site/site.tmpl: build website completely with pandoc, no hakyll-std 2018-05-09 10:13:02 -07:00
Everett Hildenbrandt
bac12543df tools/pandoc-site.hs, Shake.hs: pandoc filter version of hakyll-std website builder 2018-05-09 10:13:02 -07:00
Everett Hildenbrandt
0669111c71 Shake.hs, hakyll-std: build static parts of site directly with Shake target website-copy 2018-05-09 10:13:02 -07:00
Simon Michael
de56ee0b93 tools: use default resolver for Shake and hakyll-std again 2018-04-25 19:01:38 -07:00
Simon Michael
541e517221 tools: fix build hang in Shake
[ci skip]
2018-04-25 17:41:28 -07:00
Everett Hildenbrandt
39b20ffb3f Shake.hs: remove targets/comments about old pandoc filters 2018-04-25 17:25:09 -07:00
Everett Hildenbrandt
ddaea7cffc Shake.hs, tools/pandoc-drop-toc: switch to lua script filter 2018-04-25 17:25:09 -07:00
Everett Hildenbrandt
95c9af5664 Shake.hs, tools/pandoc-drop-notes: remove unused filter 2018-04-25 17:25:09 -07:00
Everett Hildenbrandt
fbc9c63c62 Shake.hs, tools/pandoc-drop-notes: switch to lua script filter 2018-04-25 17:25:09 -07:00
Everett Hildenbrandt
364d3dc756 Shake.hs, tools/pandoc-drop-links: switch to lua script filter 2018-04-25 17:25:09 -07:00
Everett Hildenbrandt
79e46bb0fb Shake.hs, tools/pandoc-drop-html-inlines: switch to lua script filter 2018-04-25 17:25:09 -07:00
Everett Hildenbrandt
b83240ab6d Shake.hs, tools/pandoc-drop-html-blocks: switch to lua script filter 2018-04-25 17:25:09 -07:00
Everett Hildenbrandt
33e08a7d86 Shake.hs, tools/pandoc-demote-headers: switch to lua script filter 2018-04-25 17:25:09 -07:00
Simon Michael
8ce5c84f35 tools: misc Shake, pandoc filter fixes 2018-03-31 02:43:28 +01:00
Simon Michael
7ffdcc509d doc: move most non-manual docs to the wiki 2018-03-07 23:48:08 -08:00
Simon Michael
9ab8c5c4da shake: don't generate pandoc fenced divs when transforming markdown (#692, #696)
[ci skip]
2018-01-24 18:35:19 -08:00
Simon Michael
ea1ddd86b3 shake: build with nightly resolver, remove pandoc workarounds
stackage nightly now has pandoc 2.0.5 which builds with GHC 8.2.
https://github.com/jgm/pandoc/issues/4130
2017-12-14 18:17:43 -08:00
Simon Michael
a078936c86 shake: "guidepages" also needs to build pandoc filters 2017-12-08 15:38:13 -08:00
Simon Michael
344fced409 shake: use GHC 8.0 again to avoid 8.2/pandoc error
https://github.com/jgm/pandoc/issues/4130
2017-12-08 02:52:09 -08:00
Simon Michael
316b6f344e shake: build only the needed, pandoc-2-compatible pandoc filters 2017-12-07 12:02:13 -08:00
Simon Michael
c082f2676b shake: switch to default resolver (nightly) & pandoc 2 2017-12-07 12:01:36 -08:00
Simon Michael
0f2b95041e doc: fix breakage in text manuals 2017-12-06 20:53:36 -08:00
Simon Michael
b425e50ad1 change paths in code, scripts, readme 2017-12-06 18:16:35 -08:00
Simon Michael
18d7c4b02c doc: rename Cookbook to Guide
Might need to be more specific or rename the developer/contributor guide
later. For users, for now, it's Introduction, Guide and Reference.
Still TBD where the basic getting started tutorial lives.

[ci skip]
2017-10-31 13:04:00 -07:00