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.1.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: mkdocs_pymdownx_material_extras-1.1.tar.gz
  • Upload date:
  • Size: 18.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.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for mkdocs_pymdownx_material_extras-1.1.tar.gz
Algorithm Hash digest
SHA256 2d9cbcb524b7bb82181edf6e1331cba4b9e1502e261e0b52e2229cfaafe77d6e
MD5 97ef60f8d03d55bee858eb672502bb2d
BLAKE2b-256 32336adb2af6f1115b67b7fcb6fc78dc4c65d0e47b0caf1f28146598d57fb0ab

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mkdocs_pymdownx_material_extras-1.1-py3-none-any.whl
  • Upload date:
  • Size: 20.6 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.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for mkdocs_pymdownx_material_extras-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 23a3c2034918b230c40193a8845db778949087416616ee1c5adb698cd4763f04
MD5 3a77fdc4da040abe480335a53f97c399
BLAKE2b-256 2deb21d15b19e802f92c2b75cf0c002c2f233a2a5ad2e1d2ddbcfe7803ff4903

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