On 1/10/06, Peter Seibel <[EMAIL PROTECTED]> wrote:
> This sounds a lot like my own Markup. Another similar thing is
> Markdown[1]. Of course only mine is in Lisp. ;-)

After trying HTML, Docbook, SGML, (Re)StructuredText and various other
documentation systems I have settled on the following: write one web
page with all the necessary information.  At the bottom of that page,
paste (or use SSI includes)  in, between a <pre> and a </pre>, the
contents of the example I always try and distribute in the README
file.  For examples, check

  http://common-lisp.net/project/cl-xmpp
  http://common-lisp.net/project/cl-syslog
  http://common-lisp.net/project/cl-cracklib

Etc.  If you need more information than that you either have a good
case for me to update the example or you should go look at the code or
(soon to be) autogenerated HTML documentation based off of exported
symbols in my packages.

I just don't think it has to be anything more elaborate than a simple
HTML file and a file on the filesystem with some text in it.

Erik.
_______________________________________________
Gardeners mailing list
[email protected]
http://www.lispniks.com/mailman/listinfo/gardeners

Reply via email to