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:

  • 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.
  • Resolve Markdown: Resolve variable and code snippet placeholders and serve resolved Markdown files directly from your site's build folder.

Installation

Install the plugins using pip from PyPI:

pip install papermoon-mkdocs-plugins

Usage

Enable one or more plugins in your mkdocs.yml:

plugins:
  - copy_md:
      source_dir: docs/.example
      target_dir: example
  - minify:
      minify_html: true
      minify_css: true
      minify_js: true
  - page_toggle
  - resolve_md:
      llms_config: example_config.json

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.0a4.tar.gz (24.3 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.0a4-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a4.tar.gz
Algorithm Hash digest
SHA256 7295c5f70445217bc3921967e8cfaacb99987605eecd2952ba1d06125d396f37
MD5 ec4843bf451b7966e70ee7071ee7f5d2
BLAKE2b-256 ba449b31e25ee209f1e809a11e24fbbd3ad72874c540d36436479640bc64e46d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 11211a54c4c52e2eaf11ae10bf0998d8039d9df14d60580de954e827cdb3e8d7
MD5 956befff311ab61cbc751d41b56cc500
BLAKE2b-256 97ce2ddc3087fe21b4aee1a115ea4f83127cb73af8201a66470c312a67c63e0f

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