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.0a13.tar.gz (66.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.0a13-py3-none-any.whl (71.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a13.tar.gz
Algorithm Hash digest
SHA256 5f8c9d684edff0ec8c109fb1f31770f640d5b2a4fbeaf092ae998d4c3d09edb7
MD5 4a30a4b7896fc1833578a506ec95be93
BLAKE2b-256 7a4e71ce520cd57ee5644dcbce616f83aa6fc9aeafe7b88ef13e8dc165faee28

See more details on using hashes here.

Provenance

The following attestation bundles were made for papermoon_mkdocs_plugins-0.1.0a13.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.0a13-py3-none-any.whl.

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a13-py3-none-any.whl
Algorithm Hash digest
SHA256 a6d7381847c291a38a83d4d98e87c1bb624b14eab25c05b21ccc668d5739b41e
MD5 22828a749ff9a26594367eb4487de33c
BLAKE2b-256 e31499ca20b3700601ebaf033e33bf0324499a40b00604d84404f3150f3d6e04

See more details on using hashes here.

Provenance

The following attestation bundles were made for papermoon_mkdocs_plugins-0.1.0a13-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