Re:Markdown, Asciidoc, or reStructuredText – a tale of docs-...
by bitexploder on Saturday November 05, 2022 @12:29AM
(#33477975)
We have an entire consulting documentation pipeline build on Pandoc. Everything is written in Markdown. It took a good bit of tooling to make our reports easy to write, but that is mostly automation around our industry specific artifacts. Our reports look quite nice IMO.
[ Parent
| on HN ]
Re:Markdown, Asciidoc, or reStructuredText – a tale of docs-...
by edurl on Saturday November 05, 2022 @03:36PM
(#33484812)
I would love to know more about this documentation pipeline. Anything you can share (repos, docs, tooling...?)
Thanks.
Re:Markdown, Asciidoc, or reStructuredText – a tale of docs-...
by bitexploder on Saturday November 05, 2022 @08:05PM
(#33487285)
It’s all internal, unfortunately. It essentially cobbles together markdown documents into a processing pipeline that ultimately makes a PDF. Pandoc does a lot of the heavy lifting getting it all into Latex before PDFing. We have lots of quality of life features around figures, findings, and all the things you expect in a professional report. We use Python doit, and other things to sequence out markdown fragment assembly. We have plugins for processing tool output into markdown and it will run Python and R files that generate markdown as a part of the processing pipeline so you can programmatically generate any content your heart desires. Just to give an idea of tooling :)