Markdown is now available as documentation markup

2 views
Skip to first unread message

Nickolay Platonov

unread,
Jan 12, 2010, 4:52:26 AM1/12/10
to js...@googlegroups.com
Hello,

I'd like to announce, that you now you can use the Markdown and MultiMarkdown markups for your documentation.

For details please refer to documentation of Module::JSAN::Build::Installable:
http://search.cpan.org/~nplatonov/Module-Build-JSAN-Installable-0.04/lib/Module/Build/JSAN/Installable.pm

An example of distribution, using this feature:
Documentation source: http://github.com/Joose/Joose/blob/mutability/lib/Joose.js
Resulting view: http://openjsan.org/go?l=Joose

The html version of documentation is produced on client-side, so generally support for any other markup language
can be implemented. Among nearest candidacies are: POD6 and JsDoc.

This feature is considered experimental. If you have any questions or notes, ask in this thread of welcome to #jsan of freenode.

Regards, Nickolay
Reply all
Reply to author
Forward
0 new messages