Skip to main content

Plugin to extend MkDocs Material theme.

Project description

MkDocs Pymdownx Material Extras

A plugin for MkDocs -- specifically the MkDocs Material Theme.

Adds additional resources that are used in the PyMdown Extensions documentation, and other @facelessuser projects.

While this is not specifically meant for outside consumption, and was originally written for @facelessuser projects, it can be freely used if desired.

Files are copied from the pymdown-extensions project.

Instructions

This is bound to specific versions of MkDocs Material and PyMdown Extensions. It may sometimes be tied to betas.

Installation (supported as soon as we make it available in pip)

pip install mkdocs_pymdownx_material_extras

Add it to your your mkdocs.yml plugins. It is assuming you are using MkDocs Material. When doing so, remember to add back the search plugin as it doesn't append to the plugins, but overrides the plugins:

plugins:
  - search
  - mkdocs_pymdownx_material_extras

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_pymdownx_material_extras-1.0.4.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file mkdocs_pymdownx_material_extras-1.0.4.tar.gz.

File metadata

  • Download URL: mkdocs_pymdownx_material_extras-1.0.4.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for mkdocs_pymdownx_material_extras-1.0.4.tar.gz
Algorithm Hash digest
SHA256 248a93d11f1ebdfa52bad5d236c271856718bcc5cc673383fe310520a97c554e
MD5 616731583126bef95173dc5da2bcbd80
BLAKE2b-256 69ffc3a2eaf9f149264ea967c35cb74661e99894f264b4a658b3341d251e8014

See more details on using hashes here.

Provenance

File details

Details for the file mkdocs_pymdownx_material_extras-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_pymdownx_material_extras-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for mkdocs_pymdownx_material_extras-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a0720262c6b8867f32263ae51bbed7a53482217a381c3f1ba0e78c9b8b4426f9
MD5 87713610e534414f8def30f1902c5e1a
BLAKE2b-256 39408f256f67a268d81e4f44f36325811b72d3939fe00db5addb9ba82ed03381

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page