Struct MarkdownOptions 

pub struct MarkdownOptions {
    pub gfm: bool,
    pub nixpkgs: bool,
    pub highlight_code: bool,
    pub highlight_theme: Option<String>,
    pub manpage_urls_path: Option<String>,
    pub auto_link_options: bool,
    pub valid_options: Option<HashSet<String>>,
    pub tab_style: TabStyle,
}

Options for configuring the Markdown processor.

Fields

gfm: bool

Enable GitHub Flavored Markdown (GFM) extensions.

nixpkgs: bool

Enable Nixpkgs/NixOS documentation extensions.

highlight_code: bool

Enable syntax highlighting for code blocks.

highlight_theme: Option<String>

Optional: Custom syntax highlighting theme name.

manpage_urls_path: Option<String>

Optional: Path to manpage URL mappings (for {manpage} roles).

auto_link_options: bool

Enable automatic linking for option role markup. When true, {option} roles will be converted to links to options.html. When false, they will be rendered as plain <code> elements.

valid_options: Option<HashSet<String>>

Optional: Set of valid option names for validation. When provided, only options in this set will be auto-linked. When None, all options will be linked (no validation).

tab_style: TabStyle

How to handle hard tabs in code blocks.

Implementations

impl MarkdownOptions

pub const fn with_all_features() -> Self

Enable all available features based on compile-time feature flags.

pub const fn with_features( gfm: bool, nixpkgs: bool, highlight_code: bool, ) -> Self

Create options with runtime feature overrides.

Trait Implementations

impl Clone for MarkdownOptions

fn clone(&self) -> MarkdownOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownOptions

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

Formats the value using the given formatter.

impl Default for MarkdownOptions

fn default() -> Self

Returns the “default value” for a type.