3 ms·
Org mode is my documentation secret weapon. I write books, presentations, technical documentation, and even literate data migration scripts. Some added tips: d
by agentultra 6y ago
Org mode is my documentation secret weapon. I write books, presentations, technical documentation, and even literate data migration scripts.
Some added tips: ditaa is cool but you can also integrate mermaid [0] well and display inline images. There's a well-done revealjs [1] exporter. And you can also use results blocks as input to other code blocks!
PDF export is excellent and integrates well with some scripts I wrote to publish them to my remarkable. Great for writing and then reviewing specs on the go.
The drawback is that sharing the document sources with a team is hard since so few people on a team are likely going to be emacs users. Only work around I have for that is to run emacs in batch mode to generate/export docs... or just export to markdown and maintain in markdown if the team uses a different tool or dislikes the org syntax.
[0] https://mermaid-js.github.io/mermaid/#/ https://mermaid-js.github.io/mermaid/#/
[1] https://github.com/yjwen/org-reveal https://github.com/yjwen/org-reveal
- DiggyJohnson 6y agoI am breaking the guidelines [0] in good faith to link to a mirror. Host limit exceeded on the author's blog (Thu 11 Mar 2021 01:07:37 AM UTC). https://web.archive.org/web/20210122070120/http://ehneilsen.net/notebook/orgExamples/org-examples.html https://web.archive.org/web/20210122070120/http://ehneilsen.... [0] https://news.ycombinator.com/newsguidelines.html https://news.ycombinator.com/newsguidelines.html