Skip to main content

Github Action Downloads Gitter PyPI dependabot

Material for MkDocs

A Material Design theme for MkDocs.

Material for MkDocs

Quick start

Install the latest version of Material with pip:

pip install mkdocs-material

Append the following line to your project's mkdocs.yml:

theme:
  name: 'material'

What to expect

  • Responsive design and fluid layout for all kinds of screens and devices, designed to serve your project documentation in a user-friendly way in 41 languages with optimal readability.

  • Easily customizable primary and accent color, fonts, favicon and logo; straight forward localization through theme extension; integrated with Google Analytics, Disqus and GitHub.

  • Well-designed search interface accessible through hotkeys (F or S), intelligent grouping of search results, search term highlighting and lazy loading.

For detailed installation instructions and a demo, visit https://squidfunk.github.io/mkdocs-material/

Support

If you're happy with Material for MkDocs and feel like giving something back, you may check out squidfunk's Amazon wish list.

License

MIT License

Copyright (c) 2016-2020 Martin Donath

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for mkdocs-material 4.6.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-material 4.6.3
File Size Uploaded Provenance Actions
mkdocs-material-4.6.3.tar.gz 687.3 kB Without provenance Details for mkdocs-material-4.6.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-material 4.6.3
File Interpreter ABI Platform Actions
mkdocs_material-4.6.3-py2.py3-none-any.whl Python 3, Python 2 none any Details for mkdocs_material-4.6.3-py2.py3-none-any.whl

Total release size: 1.4 MB

Release files / mkdocs-material-4.6.3.tar.gz

Download URL mkdocs-material-4.6.3.tar.gz
Size 687.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1d486635b03f5a2ec87325842f7b10c7ae7daa0eef76b185572eece6a6ea212c
BLAKE2b-256 checksum
How to use checksums
6851317f54d732a16ba5c8126ebfbe52fa1eb92332e2529b3861b30014f5fd95
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1

Release files / mkdocs_material-4.6.3-py2.py3-none-any.whl

Download URL mkdocs_material-4.6.3-py2.py3-none-any.whl
Size 723.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
7f3afa0a09c07d0b89a6a9755fdb00513aee8f0cec3538bb903325c80f66f444
BLAKE2b-256 checksum
How to use checksums
d2eea4ebd61fb45eb894fbeb6ce57320bfef69fdfee179b7323b98fc5d4bff18
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1

Security for mkdocs-material 4.6.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

4.6.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page