autoplot / documentation

documentation
0 stars 0 forks source link

migrate mediawiki to markdown #4

Open jbfaden opened 3 weeks ago

jbfaden commented 3 weeks ago

The autoplot.org server was written using Mediawiki, a good solution at the time but now causes compatibility problems for us. It would be better to simply host the site on github pages, using markdown code. There are around 150 pages creating documentation for the scientists and also documentation of internal function and plans for new features.

Pandoc is effective at moving the content to markdown. There remain several issues with the move, which include:

jbfaden commented 3 weeks ago

Code blocks, which in mediawiki are blocks where each line is indented one space, don't migrate well. Each line is back-ticked, making several separate blocks, and spaces are rewritten as  . These should be combined, or the mediawiki can have "pre" (preformatted) tags around the code block.