CodeDown

CodeDown is the title for a universal approach to program code documentation, mainly by using Markdown as the standard markup.

So far, this idea has been realized for two particular languages:

• ElephantMark, which is a documentation tool written for and in PHP (see ElephantMark).
• HaskellDown, which is the counterpart for and in Haskell. See
  • HaskellDown.hs this is the Haskell source code.
  • HaskellDownManual.html is the documentation, generated from HaskellDown.hs by means of HaskellDown, itself.
  • HaskellDown.html is the documentation of HaskellDown.hs, generated with the standard Haddock documentation tool for Haskell.
  • HaskellDownManual.markdown is the result of the first conversion step from HaskellDown.hs to HaskellDownManual.html. This intermediate result is pure Markdown. (Note, that this plain text file appears pretty distorted when viewed in the web browser.)

Please, check out this page again, soon. I intend to update it with an easy introduction and better overview, as soon as possible.

2011-04-13. This is a talk I intend to give tonight at a Haskell User Group meeting. CodeDown.pdf