Mkdocs Include Markdown Plugin
Mkdocs Markdown includer plugin
Overview
The mkdocs-include-markdown-plugin is a powerful tool designed for users of MkDocs who want to enhance their documentation by including other Markdown files or various file types directly into their project. This plugin streamlines the process of managing and organizing content across multiple files, making it easier to maintain an efficient documentation workflow. With this plugin, users can leverage the convenience of including content from different sources within their documentation without hefty manual overhead.
This versatile plugin not only simplifies the Markdown inclusion process but also offers customization options that cater to advanced user needs. Whether it's working with local files or pulling content from the web, the mkdocs-include-markdown-plugin bridges the gaps to create a cohesive documentation experience.
Features
-
Customizable Tags: Set your own opening and closing tags for inclusions, with defaults set as {% and %}, allowing for a tailored coding experience.
-
Exclusion Patterns: Utilize global exclusion wildcard patterns to ensure unwanted files are automatically ignored during inclusion.
-
Caching Support: Includes the ability to cache HTTP requests with customizable expiration times, improving performance when including remote files.
-
Flexible File Paths: Supports a variety of file paths, including absolute, relative, and remote URLs, making it easy to include content from various sources.
-
Directive Customization: Offers two main directives for including content, enabling users to adapt the functionality to fit their specific needs.
-
Indentation Control: The option to preserve indentation or dedent included content provides flexibility in maintaining formatting consistency.
-
Trailing Newline Handling: Control whether to include trailing newlines with the content, allowing for retentive formatting as desired.
-
Recursive Include Option: Choose whether to enable or disable recursive inclusion, providing control over the depth of content integration during the documentation process.
- 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.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.