MkDocs Plugins Collection

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

Currently included:

• AI Docs: Unified AI documentation plugin.
  • Generates AI-ready artifacts (resolved markdown, category bundles, site index, llms.txt), injects a per-page actions widget, and generates an AI resources page.
  • Generates structured, agent-ready skill files from a JSON configuration.
• 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.
• Link Processing: Opens external links in a new tab and adds trailing slashes to internal paths at build time.
• Snippet Var Resolver: Resolve placeholder variables inside snippet content before Markdown rendering.
• Instant Preview: Generate build-time preview manifests and safe HTML fragments for internal links without depending on Material's instant navigation runtime.

Deprecated (kept for backward compatibility, will be removed in a future major release): resolve_md, ai_page_actions, ai_resources_page. Use ai_docs instead.

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_docs:
      llms_config: llms_config.json
      agent_skills_config: agent_skills_config.json
  - copy_md:
      source_dir: docs/.example
      target_dir: example
  - minify:
      minify_html: true
      minify_css: true
      minify_js: true
  - page_toggle
  - instant_preview
  - link_processor:
      skip_internal_path_prefixes:
        - /api/
  - snippet_var_resolver

License

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