Skip to main content

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:

Example

Metadata

Release files for mkdocs-epigraph 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-epigraph 0.5.1
File Size Uploaded
mkdocs_epigraph-0.5.1.tar.gz 2.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-epigraph 0.5.1
File Interpreter ABI Platform
mkdocs_epigraph-0.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 6.9 kB

Release files / mkdocs_epigraph-0.5.1.tar.gz

Download URL mkdocs_epigraph-0.5.1.tar.gz
Size 2.9 kB
Tags Source
SHA-256 checksum
How to use checksums
a22b1881a1aff8eefa528177642cd498f203283cd13da63dd20cda665cda8787
BLAKE2b-256 checksum
How to use checksums
4dcae829f308970bfb59ed855144ce9a9c875ea2294135ede8a43c3d7f6883c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 20, 2025.

Transparency log

Release files / mkdocs_epigraph-0.5.1-py3-none-any.whl

Download URL mkdocs_epigraph-0.5.1-py3-none-any.whl
Size 4.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4d6899e9787a2b55b4c40b8a11faaa7061edd36fa1f134d100874966373d0360
BLAKE2b-256 checksum
How to use checksums
47121ebd78c3c56448840ed708542608013527854549394736f7c6079a20ed2f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jan 20, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.5.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page