Some steps toward easier inclusion of Platform Docs tutorials. #22
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.
The methodology followed thus far to include Alectryon-generated web content into rocq-prover.org (for the Tour of Rocq) was to include the generated HTML into the
.md
file for the corresponding page. This did not work well when the generated HTML had too much indentation, as this file would still be parsed as Markdown, and thus some blocks of HTML would be interpreted as blocks of code to be displayed as such.Ideally, Alectryon should be able to produce Markdown output, where only the blocks of Rocq code use the final HTML tags, and the rest of the document is still pure Markdown syntax.
In the meantime, this PR takes some steps toward including the Platform Docs tutorials in the rocq-prover.org website by introducing a new YAML key to give the body of a tutorial in a separate HTML document. The markdown body is still used to generate the table of contents. The search bar on the website will probably only work for the table of contents and not the full text, because it is based on the markdown content as well.
Unfortunately, this document still has to be post-processed from what Alectryon produced:
I've only added two tutorials for now. Two more can be easily added (up to the post-processing described above), while some others do not seem to compile with versions of Coq and/or Equations that I tried them with.
Preview (top of the page):
Preview (bottom of the page, with a link to the Platform Docs repo):