[Date Prev][Date Next][Thread Prev][Thread Next]
- Subject: Re: Documentation Markup
- From: Robert Raschke <rtrlists@...>
- Date: Fri, 9 Oct 2009 14:06:09 +0100
On Fri, Oct 9, 2009 at 12:37 PM, Geoff Leyland <firstname.lastname@example.org>
On 9/10/2009, at 11:35 PM, Peter Odding wrote:
Thanks! I did know, but I didn't think of googling "lua literate programming". A quick look didn't find much, but I'll have a better look later.
Geoff Leyland wrote:
2) I have some example files with comments explaining what they do. A tool that ran over the file, and turned it into a markdown document with the lua code embedded in it would be fantastic too. I'm not talking about a doxygen or LuaDoc type thing, I'd want the full text of the example file, just kind of turned inside out.
Just in case you don't know, this style of programming is called 'literate programming'. Knowing the right keywords makes all the difference on the internet :)
I just use a modified version of nuweb* and write HTML with embedded Lua code (no pretty-printing of code). It's been ages since I hacked it, so I can't remember the changes. It would probably be pretty trivial to change it to allow markdown.
* http://nuweb.sourceforge.net/ (I notice someone put it onto sourceforge, I have no idea anymore where I got my copy from.)