Switch page to markdown/mkdocs #253
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A test deployment is available under cvmfs.docs.cern.ch. I'm planning to use that as the main URL at some point - cvmfs.readthedocs.io can either mirror or redirect. It shouldn't be a problem either way as readthedocs.io does support mkdocs.
The biggest issue in keeping the site the same is that mkdocs has no native/simple way to handle different versions of the documentation. There's https://github.com/jimporter/mike but I'm wondering if it isn't actually better to stop building separate versions, and add colored boxes for "New in version... " and "Deprecated in ..." where deemed necessary.
RST does have a few advantages, in particular the citations have a better syntax. There's a mkdocs-bibtex plugin, but I thought it overkill, plus I couldn't get a full list of references to render correctly. So the citations are basically manually linked to the anchors in the list at the end.