Skip to main content

Module html

gruel_doc

Module html 

Source
Expand description

ADR-0089 Phase 4: HTML rendering via pulldown-cmark.

The flow is: we already have Markdown for each page (from markdown::render_markdown), so HTML rendering is “feed it through pulldown-cmark and wrap the result in a minimal <html> skeleton”. GFM extensions (tables, footnotes, strikethrough, task lists) are enabled — without these the output looks noticeably worse than what users expect from cargo doc.

Functions§

render_html
Render a single item page as a standalone HTML document.
render_html_with
ADR-0089 Phase 5: render a single item page, rewriting intra-doc links against table. When called from the site driver, table is usually DocSite::link_table().
render_index_html
Render the per-file index page (<file>/index.html).
render_index_html_with
Render the per-file index page with intra-doc link rewriting.
render_site_index_html
Render the top-level site index listing every file.
render_site_index_html_with_title
Render the top-level site index with a custom page title (ADR-0092: gruel doc uses the manifest name here when one is present).