feat: tutorials genre - #600
Merged
Merged
Conversation
Adds a genre for tutorials.
Tutorials are very much like the manual genre, and re-use most of its
infrastructure and extensions. The differences are:
1. The rendering of tutorials is more flexible, designed to fit in to
existing web designs (and in particular, the Lean design).
2. Tutorials have different metadata, and will not initially support
non-HTML output.
Additionally, tutorials will feature support for loading their content
on live.lean-lang.org and downloading their example code.
Collaborator
Author
|
TODO:
|
This will be used for buildable example projects.
Generating HTML can now be split into two separate runs. The first performs traversal and generates a file with the resulting document and the traversal state, emitting xref.json as a side effect. The second reads this serialized state and generates HTML. This is to allow multiple documents to be built together with mutual cross-references.
david-christiansen
marked this pull request as ready for review
December 19, 2025 15:56
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
1 participant
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.
Adds a genre for tutorials.
Tutorials are very much like the manual genre, and re-use most of its infrastructure and extensions. The differences are:
Additionally, tutorials will feature support for loading their content on live.lean-lang.org and downloading their example code.