Skip to main content

Documentation that simply works

Project description

MaterialX for MkDocs


MaterialX, the next generation of mkdocs-material, is based on mkdocs-material-9.7.0 and is named X. It continues to be maintained by individual developers (since mkdocs-material will cease maintenance) to keep the MkDocs ecosystem alive!



Quick start

Installation:

pip install mkdocs-materialx

Add the following lines to mkdocs.yml:

theme:
  name: materialx

[!NOTE] The theme name is materialx, not material. Everything else is the same as when using material.


For detailed installation instructions, configuration options, and a demo, visit jaywhj.github.io/mkdocs-materialx


Chat Group

Discord: https://discord.gg/cvTfge4AUy

Wechat:

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_materialx-10.0.4.tar.gz (4.1 MB view details)

Uploaded Source

Built Distribution

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

mkdocs_materialx-10.0.4-py3-none-any.whl (9.3 MB view details)

Uploaded Python 3

File details

Details for the file mkdocs_materialx-10.0.4.tar.gz.

File metadata

  • Download URL: mkdocs_materialx-10.0.4.tar.gz
  • Upload date:
  • Size: 4.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for mkdocs_materialx-10.0.4.tar.gz
Algorithm Hash digest
SHA256 1047492621c4f4398b15f368e25ad3684a45b52cbf7263c4ee86926ee60ef94b
MD5 e665fd1799dd243e015aa67728d37603
BLAKE2b-256 2063d6cb7b7f90d7b2aca373b2cb91e6c5bd77c3ed584d082179ba3273d02b62

See more details on using hashes here.

File details

Details for the file mkdocs_materialx-10.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_materialx-10.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 29b706b14167fb0e735b0aadc39a7d2acd68dbbb0a0a534c07cb8daf53816df9
MD5 56cdeba118dee9cdee5ba982f90f99ee
BLAKE2b-256 7c990dc2f1d963adbf730bef18aa6707ab65c4716d0ad22a28452aa69eae4627

See more details on using hashes here.

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