Skip to main content

render_syntax_reference

Function render_syntax_reference 

Source
pub fn render_syntax_reference() -> String
Expand description

Render the Syntax concept as a standalone reference document.

This is the single source for content/en/syntax.md (which is a committed, drift-tested mirror) and for help syntax. Each Syntax fragment becomes a ## <title> section, in registry order. LANGUAGE.md stays hand-authored as the deeper human reference; a test guards that it still covers this surface.

Examples found in repository?
examples/regen_syntax.rs (line 15)
13fn main() -> std::io::Result<()> {
14    let path = concat!(env!("CARGO_MANIFEST_DIR"), "/content/en/syntax.md");
15    std::fs::write(path, kaish_help::render_syntax_reference())?;
16    println!("regenerated {path}");
17    Ok(())
18}