|
|
|
|
|
by yashrk
884 days ago
|
|
I used org-mode files to save the examples of complex commands and code snippets (for example, for Docker, Kubernetes, bash, SQL and CQL). From the reader point of view it's literally documentation, although I'm not a professional technical writer and the only reader it's just myself (ok, sometimes I share some of this files with friends and family). If you use Emacs, you will have great editor with powerful preview features (images, formatting, table processor with formulae, code execution inside the text), and the pipeline for generating HTML or PDF will be approximately the same as with .md/.rst (org-mode is even supported by GitLab and GitHub web interface, although not perfectly). But the support of the org-mode outside Emacs is worse than of Markdown and reStructuredText. |
|