Objective
- to shut down GNUstep wiki and maintain it in markdown format somewhere else
- the 'somewhere else' is expected to
- possibly be a static site (?), easier to maintain than mediawiki,
- use git or cvs or any suitable revision control (look at Piper and CITC) so that it's easy to add new edits
- ideally be multilingual (Svetlana; this is a stretch)
- easy for newbies to edit
- use a storage format
- markdown
- rst, reST
- lightweight
- used for python documentation
- has good support for docbook
- arbitrary output formats
- can be extended;
- fully supported in Python, a partial implementation in Haskell;
- rst2xml gives you the IR as XML and then you can use XSLT to generate whatever you want;
- http://www.sphinx-doc.org/en/stable/,
- example output: http://readthedocs.org/projects/sphinx/downloads/pdf/stable/ https://docs.python.org/3/library/stdtypes.html;
- https://www.kernel.org/doc/html/latest/ — generated from reST
- org mode (emacs only)
Challenges
- leave internal wiki links as internal
- at present it is not dealt with at all, they're external to './index.php/Foo'
- parse templates (ideally into a markdown template syntax)
- at present it is dealt with by parsing them fully, without retaining the template idea
- pandoc does not have the ability to parse templates in any of its markdown outputs
Method one: wiki2md.pl (Perl script)
How to use
- download wiki2md.pl and wiki2md.txt
mkdir markdown
- run the perl script
- markdown pages are in './markdown/*.md'
Output
Sample data is in markdown.tar.gz (current as of 2017-06-11) -- will become available soon
Future work
- Identify exact requirements
- Document and code a feasible solution
- Query a mailing list to propose the solution
Add a comment