Showing posts with label documentation. Show all posts
Showing posts with label documentation. Show all posts

Sunday, January 20, 2013

TeX in JavaScript

For all your local in-browser TeX typesetting needs.  Blows my mind.  Unfortunately doesn't do italics right.

13 pointers about open-source documentation

Good pointers, too.

Friday, October 12, 2012

Sphinx documentation tool

So Sphinx is a tool used to write nice documentation for software.  It's based on DocUtils, which I'd already heard of, but apparently does a lot more; I need to read more about it but I do have to admit it looks very nice indeed.

I came to it through a blog post by Brandon Rhodes with a useful technique: if you're generating documentation from text files that won't be read by the end user, then break lines at major phrases and periods.  This permits you to revise your text while allowing the VCS to see where the changes really are (that is, you don't need to rearrange your text to reflect margins).

Monday, September 17, 2012

Animated GIFs

I'm not even sure where to file this, but it's such a cool application of graphics that I have to remember it: the animated code screenshots for Sublime Text 2.0.