Metadata-Version: 2.4
Name: papermoon-mkdocs-plugins
Version: 0.1.0a8
Summary: A collection of MkDocs plugins
Author: Papermoon
License-Expression: BSD-2-Clause
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.6
Requires-Dist: mkdocs-material>=9.0
Requires-Dist: pymdown-extensions>=10.0
Requires-Dist: htmlmin2>=0.1.13
Requires-Dist: jsmin>=3.0.1
Requires-Dist: csscompressor>=0.9.5
Requires-Dist: beautifulsoup4==4.14.2
Requires-Dist: packaging>=23.0
Requires-Dist: pyyaml>=6.0
Dynamic: license-file

# MkDocs Plugins Collection

A collection of custom [MkDocs](https://www.mkdocs.org/) plugins designed to extend [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).

Currently included:

- **[AI Resources Page](https://github.com/papermoonio/mkdocs-plugins/blob/main/docs/ai-resources-page.md)**: Automate the generation of an "AI Resources" page with a dynamic table of artifact files.
- **[Copy Markdown](https://github.com/papermoonio/mkdocs-plugins/blob/main/docs/copy-md.md)**: Serve raw Markdown files by copying them directly to your site's build folder.
- **[Minify](https://github.com/papermoonio/mkdocs-plugins/blob/main/docs/minify.md)**: Minify HTML, JS, and CSS files globally or by scope to optimize your site's performance.
- **[Page Toggle](https://github.com/papermoonio/mkdocs-plugins/blob/main/docs/page-toggle.md)**: Create variant pages for the same content and display them with an interactive toggle interface.
- **[Resolve Markdown](https://github.com/papermoonio/mkdocs-plugins/blob/main/docs/resolve-md.md)**: Resolve variable and code snippet placeholders and serve resolved Markdown files directly from your site's build folder.
- **[AI Page Actions](https://github.com/papermoonio/mkdocs-plugins/blob/main/docs/ai-page-actions.md)**: Injects a per-page AI actions widget next to each page's H1 heading at build time.

Helper utilities and libraries: 

- **[AI File Actions](https://github.com/papermoonio/mkdocs-plugins/blob/main/docs/helper_library/ai-file-actions.md)** *(shared library)*: Convenience wrapper around `ai_file_utils` for generating AI file action dropdowns.
- **[AI File Utils](https://github.com/papermoonio/mkdocs-plugins/blob/main/docs/helper_library/ai-file-utils.md)** *(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:

```bash
pip install papermoon-mkdocs-plugins
```

## Usage

Enable one or more plugins in your `mkdocs.yml`:

```yaml
plugins:
  - ai_resources_page
  - ai_page_actions
  - 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](LICENSE).
