Add epigraphs to your MkDocs documentation
Project description
MkDocs Epigraph Plugin
This plugin allows you to add epigraphs to your MkDocs pages. An epigraph is a short quotation or saying at the beginning of a book or chapter, intended to suggest its theme.
It is compatible with MkDocs Material.
Installation
Install the plugin using pip:
pip install mkdocs-epigraph
Activate the plugin in your mkdocs.yml:
plugins:
- epigraph
Usage
In you pages, you can add an epigraph in the YAML front matter:
---
epigraph:
text: "It is during our darkest moments that we must focus to see the light."
source: Aristotle
---
# Find the light
Which will render as:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_epigraph-0.5.1.tar.gz.
File metadata
- Download URL: mkdocs_epigraph-0.5.1.tar.gz
- Upload date:
- Size: 2.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a22b1881a1aff8eefa528177642cd498f203283cd13da63dd20cda665cda8787
|
|
| MD5 |
72fd087a66534d8ce7d647b604fea617
|
|
| BLAKE2b-256 |
4dcae829f308970bfb59ed855144ce9a9c875ea2294135ede8a43c3d7f6883c2
|
Provenance
The following attestation bundles were made for mkdocs_epigraph-0.5.1.tar.gz:
Publisher:
workflow.yml on yves-chevallier/mkdocs-epigraph
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_epigraph-0.5.1.tar.gz -
Subject digest:
a22b1881a1aff8eefa528177642cd498f203283cd13da63dd20cda665cda8787 - Sigstore transparency entry: 163887257
- Sigstore integration time:
-
Permalink:
yves-chevallier/mkdocs-epigraph@2c07c0220c7e010ad37debbb5633151c412a3d72 -
Branch / Tag:
refs/tags/v0.5.1 - Owner: https://github.com/yves-chevallier
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
workflow.yml@2c07c0220c7e010ad37debbb5633151c412a3d72 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mkdocs_epigraph-0.5.1-py3-none-any.whl.
File metadata
- Download URL: mkdocs_epigraph-0.5.1-py3-none-any.whl
- Upload date:
- Size: 4.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4d6899e9787a2b55b4c40b8a11faaa7061edd36fa1f134d100874966373d0360
|
|
| MD5 |
86ac04e30abc1bee105035753da48a3b
|
|
| BLAKE2b-256 |
47121ebd78c3c56448840ed708542608013527854549394736f7c6079a20ed2f
|
Provenance
The following attestation bundles were made for mkdocs_epigraph-0.5.1-py3-none-any.whl:
Publisher:
workflow.yml on yves-chevallier/mkdocs-epigraph
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_epigraph-0.5.1-py3-none-any.whl -
Subject digest:
4d6899e9787a2b55b4c40b8a11faaa7061edd36fa1f134d100874966373d0360 - Sigstore transparency entry: 163887258
- Sigstore integration time:
-
Permalink:
yves-chevallier/mkdocs-epigraph@2c07c0220c7e010ad37debbb5633151c412a3d72 -
Branch / Tag:
refs/tags/v0.5.1 - Owner: https://github.com/yves-chevallier
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
workflow.yml@2c07c0220c7e010ad37debbb5633151c412a3d72 -
Trigger Event:
push
-
Statement type: