Skip to main content

Crate docgen_core

Crate docgen_core 

Source

Re-exports§

pub use graph::LinkGraph;
pub use graphlayout::graph_data_json;
pub use graphlayout::layout_graph;
pub use graphlayout::GraphData;
pub use graphlayout::GraphDataEdge;
pub use graphlayout::GraphNode;
pub use graphlayout::LayoutParams;
pub use headings::Heading;
pub use model::Doc;
pub use model::LinkEdge;
pub use model::RawDoc;
pub use model::SearchEntry;
pub use model::TreeNode;
pub use pipeline::prepare;
pub use pipeline::render_docs;
pub use pipeline::PreparedDoc;
pub use pipeline::SiteBuild;

Modules§

assemble
assetpass
AST pass that rewrites relative asset references in a doc body to base-absolute URLs.
asseturl
An S3-agnostic hook that lets the asset-URL rewrite pass point a resolved, docs-root-relative asset path at an externally-hosted URL (e.g. an S3/CDN object). docgen-core owns the trait so it never depends on docgen-s3; the S3 crate implements it. When no resolver is supplied, the pass emits the usual base-absolute local URL.
directivepass
Source-level directive pre/post pass. extract rewrites raw markdown, replacing each directive with an HTML-comment sentinel and returning the parsed instances; substitute swaps sentinels for rendered component HTML after comrak has formatted the surrounding markdown.
discover
frontmatter
graph
graphlayout
Deterministic force-directed layout for the /graph/ view.
headings
Extract the h2/h3 heading outline of a document and stamp matching id anchors onto the rendered heading tags.
markdown
math
Build-time KaTeX rendering. Each math expression in a document is rendered to static HTML at build time via the katex crate (default quick-js backend), so the generated site ships zero runtime JS for math.
mathpass
AST pass that replaces comrak math nodes with build-time KaTeX HTML.
mermaidpass
AST pass that replaces ```mermaid fenced code blocks with an Alpine island container.
model
pipeline
search
tablepass
AST pass that wraps every GFM table in a horizontal-scroll container.
tree
util
Small shared helpers used by the AST passes.
wikilink