Skip to main content

A collection of MkDocs plugins

Project description

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.
  • 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.

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
  - copy_md:
      source_dir: docs/.example
      target_dir: example
  - minify:
      minify_html: true
      minify_css: true
      minify_js: true
  - page_toggle

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

papermoon_mkdocs_plugins-0.1.0a9.tar.gz (62.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

papermoon_mkdocs_plugins-0.1.0a9-py3-none-any.whl (66.0 kB view details)

Uploaded Python 3

File details

Details for the file papermoon_mkdocs_plugins-0.1.0a9.tar.gz.

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a9.tar.gz
Algorithm Hash digest
SHA256 8771f120645aedd56e49d8a73afc069688f3d6973ceaa5bc0b8fbda28d4b6de2
MD5 164aab16b17b3de97662c852687ab96e
BLAKE2b-256 7bb7525f594c796c6fa601a66723e9d096d3a3fd8200c39ba518ddf7f706fcca

See more details on using hashes here.

File details

Details for the file papermoon_mkdocs_plugins-0.1.0a9-py3-none-any.whl.

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a9-py3-none-any.whl
Algorithm Hash digest
SHA256 46c1258ed1858da5132fc6f25bd655d439f1aedd72d435191025b658e602dfaa
MD5 15938e7520197a20eea0c99944fa9072
BLAKE2b-256 16dbd6a6b77d6c3721f2579ab80639e2c1e29a1fdbdabd8cd97968ea3b816e80

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page