mirror of
https://github.com/google/comprehensive-rust.git
synced 2024-12-15 06:20:32 +02:00
4815264e2d
In v2 of the course, I'd like to include an estimate of the time to be spent on each segment in the Markdown file. I think a good place for such metadata is in the frontmatter. For review purposes, though, I just want to display that information. So, this is a start at a new mdbook preprocessor that just separates out the frontmatter and includes it in a `<pre>` block. Eventually, I'd like to parse it and put the time in the speaker notes. --------- Co-authored-by: Martin Geisler <martin@geisler.net> |
||
|---|---|---|
| .. | ||
| src | ||
| Cargo.toml | ||
| README.md | ||
mdbook-course
This is an mdBook preprocessor to handle some specific details of Comprehensive Rust.
Frontmatter
The preprocessor parses "frontmatter" -- YAML between --- at the beginning of
a Markdown file -- and removes it from the rendered result. At the moment, to
aid review of the new course, it places this content in a <pre> block.
Future Work
- Parse the
minutesproperty from frontmatter and- Generate a course timeline
- Include timing information in the speaker notes
- Generate per-segment tables of contents.