Skip to main content

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:

Example

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_epigraph-0.5.1.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

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

mkdocs_epigraph-0.5.1-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

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

Hashes for mkdocs_epigraph-0.5.1.tar.gz
Algorithm Hash digest
SHA256 a22b1881a1aff8eefa528177642cd498f203283cd13da63dd20cda665cda8787
MD5 72fd087a66534d8ce7d647b604fea617
BLAKE2b-256 4dcae829f308970bfb59ed855144ce9a9c875ea2294135ede8a43c3d7f6883c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_epigraph-0.5.1.tar.gz:

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

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_epigraph-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_epigraph-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4d6899e9787a2b55b4c40b8a11faaa7061edd36fa1f134d100874966373d0360
MD5 86ac04e30abc1bee105035753da48a3b
BLAKE2b-256 47121ebd78c3c56448840ed708542608013527854549394736f7c6079a20ed2f

See more details on using hashes here.

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

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