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.
  • 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
  - 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.0a3.tar.gz (21.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.0a3-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a3.tar.gz
Algorithm Hash digest
SHA256 297d0dfe5f40a5804daf7607817fd2f99d21de651c4a288106fffd4228d52b20
MD5 0946606a823a8b5ad968edae0b69c49d
BLAKE2b-256 8fc198e82ad4aecfa44e47ed5ef3d3d514374d83b13ad722a23ad8246f3efdaf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for papermoon_mkdocs_plugins-0.1.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 4e48d9cdf834aec759162271debf4b091e9feec15502c356527dfd557250886c
MD5 4441de6f23c4eb7902ee0b3b8fcb05f8
BLAKE2b-256 ec05dfe5c643ea2d1245957640bd4c72c58818e5ae01c543c6a3df1876beb447

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