Skip to main content

Add pillss to your MkDocs documentation

Project description

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:

pip install mkdocs-pills

Activate the plugin in your mkdocs.yml:

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:

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

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

mkdocs_pills-0.1.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_pills-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_pills-0.1.0.tar.gz.

File metadata

  • Download URL: mkdocs_pills-0.1.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for mkdocs_pills-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a172cb81e3f695dc66a3943a1fbbe4fa3a3e7f6ff8f613d250f224c23a0faa26
MD5 1fd5ed092fc09115a5c7ee917bb5f9b6
BLAKE2b-256 33435509ab8dc787542d00361a4acfa0635ca95f104839ea0271155ece7c5669

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_pills-0.1.0.tar.gz:

Publisher: workflow.yml on yves-chevallier/mkdocs-pills

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_pills-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_pills-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for mkdocs_pills-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2d3bed88601fbebc7f5ed2e712c5689e670a230eaaaab86e829f5279b763557
MD5 b596b9af8efcc925572d813205e037b6
BLAKE2b-256 4292dad568095b852c84f1df30939fa364bf7e12c0fbc71c6196c66bdd3904e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_pills-0.1.0-py3-none-any.whl:

Publisher: workflow.yml on yves-chevallier/mkdocs-pills

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