Crate mdbook_utils

mdbook-utils

To use the command-line tool, run mdbook-utils at a shell prompt. A list of commands will be displayed.

The following is the library API doc. This crate can be used if more control is required.

Some reasons why you would want to use the crate (over the CLI):

• Integrate it in your project
• Extend its capabilities
• …

Modules

• markdown
  Operations on Markdown that are not link- or reference-related
• test_markdown
  Example Markdown for testing

Functions

• debug_parse_to
  Parse Markdown from all .md files in a given source directory and write all raw events to a file for debugging purposes
• generate_badges
  Parse Markdown from all .md files in a given source directory, extract existing reference definitions, identify URLs that are GitHub repos, create badge URLs for these links, and write to a file.
• generate_refdefs_to
  Given a Cargo.toml path, generate reference definitions from code dependencies and write them to a file
• generate_sitemap
  Create a sitemap.xml file from the list of Markdown files in a source directory
• test
  Test function that uses fake Markdown
• write_all_links
  Parse Markdown from all .md files in a given source directory, write all links found therein to a file
• write_broken_links
  Parse Markdown from all .md files in a given source directory, write duplicated links found therein to a file
• write_duplicate_links
  Parse Markdown from all .md files in a given source directory, write duplicated links found therein to a file
• write_inline_links
  Parse Markdown from all .md files in a given source directory, write all inline links and autolinks (i.e., not written as reference-style links) found therein to a file
• write_refdefs_to
  Parse Markdown from all .md files in a given source directory and write reference definitions found therein to a file