process_option_references

ndg_commonmark::processor::extensions

Function process_option_references 

Source 
pub fn process_option_references(
    html: &str,
    valid_options: Option<&HashSet<String>>,
) -> String
Expand description

Process option references Converts {option} role markup into links to the options page.

This processes <code> elements that have the nixos-option class, i.e., {option} role markup and convert them into links to the options page.

§Arguments

  • html - The HTML string to process.
  • valid_options - Optional set of valid option names for validation.

§Returns

The HTML string with option references rewritten as links.