dariuszporowskidariuszporowski
10

Mkdocs File Filter Plugin

screenshot of Mkdocs File Filter Plugin
mkdocs

A MkDocs plugin that lets you exclude/include docs files using globs, regexes, gitignore-style file and Markdown/FrontMatter tags metadata.

GithubDemo

Overview

The MkDocs File Filter Plugin is a powerful tool designed for users of MkDocs, allowing for refined control over which files are included or excluded from documentation builds. Currently in early alpha, this plugin offers a range of features using Unix-style wildcards, regular expressions, and even custom metadata tags. Though it is still in development and may not be fully compatible with all configurations yet, it presents exciting potential for developers looking to streamline their documentation processes.

With its ability to manage visibility of files based on various filtering mechanisms, users can better organize their documentation and enhance the overall quality of their projects. While there are some considerations regarding its early stage of development, the MkDocs File Filter Plugin lays a strong foundation for future use.

Features

  • File Exclusion/ Inclusion: Utilize Unix-style wildcards and regular expressions to easily specify which files to include or exclude from your documentation builds.
  • .mkdocsignore Support: Similar to gitignore, you can exclude files via a .mkdocsignore file, making it easier to manage large projects with multiple files.
  • Markdown/FrontMatter Tags: Incorporate tags in your Markdown or FrontMatter to selectively filter out content based on metadata properties.
  • External Configuration Support: Dynamically load plugin configuration from external files, allowing for flexibility in different environments and CI/CD setups.
  • Compatibility: Designed to work with MkDocs version 1.4.0 or higher and Python >=3.8, ensuring you're using current technologies.
  • Toggle Functionality: Enable or disable the plugin without removing configurations, giving you control when running the serve command.
  • Navigation Filtering: Streamline documentation pages by filtering out unnecessary content from navigation menus, enhancing user experience.
  • Advanced Options: Customize functionality with various options like limiting filtering to only documentation pages, providing greater granularity in document management.
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.