Mkdocs Add Number Plugin

Overview:

The mkdocs-add-number-plugin is a handy tool designed to enhance your MkDocs documentation by automatically numbering headings (h1-h6) in rendered HTML pages. This feature can be particularly beneficial for users who have complex documents and want to ensure a clear, organized structure. Unlike other plugins, it does not alter the original markdown files, making it a lightweight solution for improved readability in the final output.

Installing the plugin is simple, and once set up, it allows for extensive customization to better fit your documentation needs. The flexibility of the various options ensures that users can tailor the numbering system to their specific requirements, whether they need strict adherence to heading order or a more relaxed approach.

Features:

• Easy Installation: Install via pip3 or build from source with a straightforward setup process.
• Configurable numbering modes: Choose between strict mode for sequential numbering based on heading order or a relaxed mode for more flexible structuring.
• Custom starting order: Specify a heading level to start numbering from, allowing you to exclude certain titles from being counted.
• Exclusion Options: Exclude specific files or folders from numbering, providing control over what gets included in the final output.
• Increment Navigation: Adjust settings to enable numbering for top-level and secondary navigation, enhancing organization within your site's layout.
• Clear Syntax Requirements: Simple guidelines ensure that your headings are correctly formatted for effective numbering, helping to avoid common errors.
• Effective in Large Documents: Particularly useful for lengthy documentation, making it easier for readers to follow and navigate through content.