MkDocs Plugins Collection

A collection of custom MkDocs plugins designed to extend Material for MkDocs.

Currently included:

• AI Resources Page: Automate the generation of an "AI Resources" page with a dynamic table of artifact files.
• Copy Markdown: Serve raw Markdown files by copying them directly to your site's build folder.
• Minify: Minify HTML, JS, and CSS files globally or by scope to optimize your site's performance.
• Page Toggle: Create variant pages for the same content and display them with an interactive toggle interface.
• Resolve Markdown: Resolve variable and code snippet placeholders and serve resolved Markdown files directly from your site's build folder.
• AI Page Actions: Injects a per-page AI actions widget next to each page's H1 heading at build time.

Helper utilities and libraries:

• AI File Actions (shared library): Convenience wrapper around ai_file_utils for generating AI file action dropdowns.
• AI File Utils (shared library): Resolves action definitions from JSON and generates split-button dropdown HTML for copy, download, view, and LLM tool actions.

Installation

Install the plugins using pip from PyPI:

pip install papermoon-mkdocs-plugins

Usage

Enable one or more plugins in your mkdocs.yml:

plugins:
  - ai_resources_page
  - ai_page_actions
  - copy_md:
      source_dir: docs/.example
      target_dir: example
  - minify:
      minify_html: true
      minify_css: true
      minify_js: true
  - page_toggle
  - resolve_md:
      llms_config: example_config.json

License

This repository is licensed under the BSD-2-Clause License.