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.5.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.5-py3-none-any.whl (9.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_materialx-10.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 df5c1e4e0d9e1b39ae06b2f4afd4391444b129a0d718d0c817d60f428f096da2
MD5 109149b1ecc5e32fb288663dc8c1f714
BLAKE2b-256 3d2d1197183958ca3d57189a9dc3e77ce15c2b014b39611c89117838411f5ea2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_materialx-10.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 edae3374606308a3aaf04ec40b9ee034919dba41e8829a83ccf9b8374ee4a84e
MD5 e5168c8e8e15e12a53316875482882d3
BLAKE2b-256 7a75dfea7030ff3e624ea7a119f5d34749f3a00749bc0895a295113f9635ab6c

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