Struct MarkdownRenderer 

pub struct MarkdownRenderer { /* private fields */ }

Implementations

impl MarkdownRenderer

pub fn render_arg(&self, arg: &SpecArg) -> Result<String, UsageErr>

impl MarkdownRenderer

pub fn render_cmd(&self, cmd: &SpecCommand) -> Result<String, UsageErr>

impl MarkdownRenderer

pub fn render_config(&self) -> Result<String, UsageErr>

The settings reference for a spec’s config block.

Empty string when there is nothing to say, so a caller can concatenate it without checking — a CLI with no settings should not grow a blank section.

impl MarkdownRenderer

pub fn render_flag(&self, flag: &SpecFlag) -> Result<String, UsageErr>

impl MarkdownRenderer

pub fn new(spec: Spec) -> Self

pub fn config_page(&self) -> &'static str

The file name the settings page gets in --multi mode.

One name, always. settings.md was the obvious choice and the wrong one: mise has a settings command, whose own page lands there, and config is written second — so for the very CLI this feature is aimed at, the command’s page was silently replaced and the index linked both entries to the same file.

Choosing between two names by whether a command is in the way would fix that and introduce something worse: the name would move when a command is added or removed between runs, leaving the abandoned one behind as a stale page nothing links but the docs site still serves. A fixed name cannot do that, and configuration is a name CLIs give to a file, not to a command — the command is called config.

pub fn config_page_collision(&self) -> Option<&str>

A visible top-level command whose own page would be written to Self::config_page.

Vanishingly unlikely, and silence is what made the settings.md collision hard to see, so the one case left is reported rather than guessed at.

pub fn with_header_level(self, header_level: usize) -> Self

pub fn with_multi(self, index: bool) -> Self

pub fn with_url_prefix<S: Into<String>>(self, url_prefix: S) -> Self

pub fn with_html_encode(self, html_encode: bool) -> Self

pub fn with_replace_pre_with_code_fences( self, replace_pre_with_code_fences: bool, ) -> Self

impl MarkdownRenderer

pub fn render_spec(&self) -> Result<String, UsageErr>

pub fn render_index(&self) -> Result<String, UsageErr>

Trait Implementations

impl Clone for MarkdownRenderer

fn clone(&self) -> MarkdownRenderer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MarkdownRenderer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.