Metadata-Version: 2.3
Name: mkdocs-pills
Version: 0.1.0
Summary: Add pillss to your MkDocs documentation
License: MIT
Keywords: mkdocs,python,pills,badges
Author: Yves Chevallier
Author-email: yves.chevallier@heig-vd.ch
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: mkdocs (>=1.6.1,<2.0.0)
Project-URL: Documentation, https://github.com/yves-chevallier/mkdocs-pills
Project-URL: Source, https://github.com/yves-chevallier/mkdocs-pills
Project-URL: Tracker, https://github.com/yves-chevallier/mkdocs-pills/issues
Description-Content-Type: text/markdown

# MkDocs Pills Plugin

This plugin allows you to add pills to your MkDocs pages. It is compatible with MkDocs Material and MkDocs Books.

## Installation

Install the plugin using pip:

```bash
pip install mkdocs-pills
```

Activate the plugin in your `mkdocs.yml`:

```yaml
plugins:
  - pills:
      unicode: true # default: true
      regex: true # default: true
```

## Usage

In you pages, you can add regex pills or unicode pills using the following syntax:

```markdown
Do you know the unicode char U+1F600? Unicode can be matched using the regex: `#!re /U\+([0-9A-F]{4})/`.
```
