From: Karsten Schmidt <info@toxi.co.uk>
To: emacs-orgmode@gnu.org
Subject: [ANN] thi.ng/org-spec template for tech specs & HTML export theme
Date: Sun, 31 Jul 2016 13:53:52 +0100 [thread overview]
Message-ID: <CAKoXdG6tsG13Ehtm_3wobOWMK=_3nECcOuEgkK8UhB=-H6Niig@mail.gmail.com> (raw)
Hi everyone,
this is my first post to this list, but I've been using org-mode daily
for the past 3.5 years and can't imagine living without anymore
(professionally). Thanks for bringing so much joy to my job! :)
My main use case for org-mode has been literate programming[1] and
recently also writing lots of technical specification docs, for which
I believe org-mode is *perfectly* suited.
To give a little back to this amazing group of people, I've just
published a skeleton template for writing tech docs and publishing
them as HTML.
GH project: http://thi.ng/org-spec
Demo: http://demo.thi.ng/org-spec
The template demonstrates the following features:
- Inline, text-based diagramming via Ditaa, Graphviz & PlantUML
- Hyperlink abbreviations (incl. presets for GitHub, RFC, W3C, Wikipedia)
- Section status flags, tags & custom properties
- Tables
- Named section IDs for internal x-refs
- Footnotes
- Automatically updating fields (e.g. publication date)
- Automatic updating of document changelog (using selective git commits)
- Beautiful, minimal, responsive CSS theme with print support (also
for PDF generation)
- Basic syntax highlighting of code blocks
Hope some of you find this useful! PRs are welcome!
Best, K.
[1] Several Clojure projects in my thi.ng collection have been
developed exclusively in org-mode: http://thi.ng/fabric,
http://thi.ng/geom, http://thi.ng/trio to name a few...
--
Karsten Schmidt
http://thi.ng | http://postspectacular.com | http://toxiclibs.org
next reply other threads:[~2016-07-31 12:53 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-31 12:53 Karsten Schmidt [this message]
2016-08-01 22:35 ` [ANN] thi.ng/org-spec template for tech specs & HTML export theme Kaushal Modi
2016-08-03 11:00 ` Karsten Schmidt
2016-08-01 23:47 ` Adam Porter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAKoXdG6tsG13Ehtm_3wobOWMK=_3nECcOuEgkK8UhB=-H6Niig@mail.gmail.com' \
--to=info@toxi.co.uk \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).