AshleyYakeley / Truth

Changes and Pinafore projects. Pull requests not accepted.
https://pinafore.info/
GNU General Public License v2.0
32 stars 0 forks source link

Switch to better docs system #216

Closed AshleyYakeley closed 5 months ago

AshleyYakeley commented 1 year ago

MkDocs does not and will not support CommonMark on its own (mkdocs/mkdocs#1835), and the plugin to support it (mkdocs-plugin-commonmark) has been abandoned and no longer works with the latest MkDocs.

Probably mdBook?

AshleyYakeley commented 5 months ago

mdBook uses highlight.js instead of Pygments.

AshleyYakeley commented 5 months ago

MkDocs

mdBook

Sphinx

astrojuanlu commented 5 months ago

Sphinx supports Markdown https://myst-parser.readthedocs.io/

AshleyYakeley commented 5 months ago

Thanks, I'll check it out.

AshleyYakeley commented 5 months ago

Myst's parser (markdown-it-py) doesn't support file transclusion, and there don't appear to be any plugins for it that do that. nm, figured out how to do this

AshleyYakeley commented 5 months ago

Done.