|
|
Subscribe / Log in / New account

Emacs and changing documentation formats

Emacs and changing documentation formats

Posted Dec 12, 2014 12:49 UTC (Fri) by deepfire (guest, #26138)
Parent article: Emacs and changing documentation formats

Orgmode is amazing. For me it's easily the most useful single feature of emacs.

My experience with writing documentation in it is enjoyable, with the only problem being the PDF export pipeline seemingly never quite working by default. But that problem is about documentation export.

The lovely thing about Org is the _ease of document composition_.
The simple ergonomics it has for extending, reorganising, drilling down into the document outline -- it's really in a class of its own.

When you add the power of Org markup, like dictionaries, term definition anchors, various kinds of links, source code blocks (executable!), node states, per-node-properties.. it all really quickly becomes hard to resist.

Org is very light-weight, and very expressive at the same time.


to post comments

Emacs and changing documentation formats

Posted Dec 16, 2014 20:21 UTC (Tue) by sjj (guest, #2020) [Link] (1 responses)

I have made a couple of false starts using Org as a GTD/todo/etc app over the years. I haven't gotten the habit to stick very well, but I keep returning to it because it is pretty awesome.

I just started putting our company sysadmin docs into Org documents, stored in git and rendered to web pages with this: https://github.com/fniessen/org-html-themes and I'm in love.

If Emacs wants to ditch texinfo, they could do much worse than use Orgmode instead.

Emacs and changing documentation formats

Posted Dec 23, 2014 6:56 UTC (Tue) by blujay (guest, #39961) [Link]

That is really fantastic! Thanks for sharing.


Copyright © 2025, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds