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.
  • Link Processing: Opens external links in a new tab and adds trailing slashes to internal paths at build time.

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
  - link_processor:
      skip_internal_path_prefixes:
        - /api/

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.0a10.tar.gz (63.6 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.0a10-py3-none-any.whl (67.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a10.tar.gz
Algorithm Hash digest
SHA256 6f68f80c7d670d3b797c6aac6fcbb65ed9fc73708dd7788d7e67304635a01315
MD5 80d7b7f714340167af0fec5245455f56
BLAKE2b-256 f7883aa67f85b849004ac87624870f7cc14fda3fee76bad64eb613e87f912be8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a10-py3-none-any.whl
Algorithm Hash digest
SHA256 ca688d1cd16ba47cba9786d185c6f400316155c1fdd1fe98dafecc7022b97a39
MD5 babdbaff5eb2484370a1611ca592dfef
BLAKE2b-256 a9c3c72d04129d3210f4b1900f8d981e0a4b9cb13471640df922f4573f49aee8

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