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

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
  - 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.0a15.tar.gz (70.8 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.0a15-py3-none-any.whl (75.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a15.tar.gz
Algorithm Hash digest
SHA256 9ef11a7343ecb399766ee528ad61815caead216fc8b38a800c6551b403540b93
MD5 a2d399beb1c8385a139e82fd67192f3e
BLAKE2b-256 a48300ea46641ceab8a9eb878ec42352791e4b8cdabe8fe097d0ce2e8dbf76f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for papermoon_mkdocs_plugins-0.1.0a15.tar.gz:

Publisher: release.yml on papermoonio/mkdocs-plugins

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a15-py3-none-any.whl
Algorithm Hash digest
SHA256 5776ad92fceb1fbacb5e77a991c3b894947fb9489011fbf86bf464d031f86715
MD5 72f5adc68b1cda70e49a9ffc1dfdb5a4
BLAKE2b-256 0bea84bbc45d5ee699a91005cecdfecc77eb516c657fe90448dcb5d7064cba77

See more details on using hashes here.

Provenance

The following attestation bundles were made for papermoon_mkdocs_plugins-0.1.0a15-py3-none-any.whl:

Publisher: release.yml on papermoonio/mkdocs-plugins

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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