Add script + pandoc template to turn README.md into docs site#1419
Draft
Scotsguy wants to merge 3 commits into9001:hovudstraumfrom
Draft
Add script + pandoc template to turn README.md into docs site#1419Scotsguy wants to merge 3 commits into9001:hovudstraumfrom
Scotsguy wants to merge 3 commits into9001:hovudstraumfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
pandoc is a very versatile tool for converting between document formats. one of the output formats it supports is "chunkedhtml", which consists of multiple html files, one for each top-level heading of the input.
inspired by this tangled blogpost, we can use pandoc and a custom template that moves the table of contents into a sidebar, we can turn the README.md into a quite passable docs site without rewriting everything:
TODO:
Details
CSS for tablesdoneneeds discussion:
in particular, the hack for centering images while also letting them be wider than the text doesn't affect the scroll bar, so you can scroll to the right into nothingnessfixed (worked around?)This PR complies with the DCO; https://developercertificate.org/