Skip to main content

Plugin to extend MkDocs Material theme.

Project description

MkDocs Pymdownx Material Extras

A plugin that for MkDocs and 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.tar.gz (17.3 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

  • Download URL: mkdocs_pymdownx_material_extras-1.0.tar.gz
  • Upload date:
  • Size: 17.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for mkdocs_pymdownx_material_extras-1.0.tar.gz
Algorithm Hash digest
SHA256 6a9ab36710e34f964496a7298ded94bd5b20e177229314ac2e5e5355045ee4c1
MD5 0c5de03872e652ef417b6250c2570ea4
BLAKE2b-256 926827583f8bce6e87f56556cee346eaded6223c56601cd372e4b46e031c2b68

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mkdocs_pymdownx_material_extras-1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for mkdocs_pymdownx_material_extras-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd356d68c2cfc874b707f38d20e2b2bedd2aafaed325dab7003cbb66ec28869d
MD5 a417d2b9028934a8168d62369a13a3e2
BLAKE2b-256 b7307cacd7f1bb95deec1c9b5ada324ddba79a9f47ea3b14762db29271568de4

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