manuzhangmanuzhang
48

Mkdocs Htmlproofer Plugin

screenshot of Mkdocs Htmlproofer Plugin
mkdocs

A MkDocs plugin that validates URL in rendered html files

Github

Overview

The mkdocs-htmlproofer-plugin is a powerful tool designed for MkDocs users who want to ensure the integrity of their documentation by validating URLs in rendered HTML files. This plugin is especially useful for projects that have numerous links or anchors, as it helps catch dead links before publishing, enhancing the overall quality of the documentation. With built-in flexibility to configure various validation settings, this plugin can streamline the development process while maintaining accuracy.

This plugin is compatible with MkDocs versions 1.4.0 and above, and offers several useful features to optimize the validation process. Whether you're a solo developer or part of a larger team, having a tool that checks for broken links and offers customization options can save time and improve productivity.

Features

  • Easy Installation: Simple to add to your project with the pip package manager, just update your mkdocs.yml configuration file.

  • Customizable Validation: Toggle the validation on or off easily with the enabled option, allowing for faster local builds during development.

  • Error Handling Options: Flexible settings such as raise_error and raise_error_after_finish help manage how errors are handled, providing control over the validation process.

  • Exclusion Flexibility: The raise_error_excludes and ignore_urls options permit you to bypass specific URLs, giving you the ability to customize which links are validated.

  • Efficiency in Validating Local Anchors: The validate_external_urls option allows you to skip checking external links for quicker validation of local documentation anchors.

  • Rendering Template Validation: By validating the complete rendered template for each page, the plugin ensures overall consistency, though this feature is off by default to save time.

  • Support for Multilingual Documentation: Works seamlessly with the attr_list extension for manually specifying anchors, making it perfect for documentation in multiple languages.

  • Warning System for Ignored URLs: The warn_on_ignored_urls option can be activated to log warnings whenever URLs are ignored, keeping you informed of potential issues without causing interruptions.

mkdocs
MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.