This release is a pre-release and may not be stable for production use.
Material for MkDocs
⚠️ Help test Material 5!
A Material Design theme for MkDocs.
Quick start
Install the latest version of Material with pip:
pip install mkdocs-material
Add the following line to 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.
1 maintainer
Release files for mkdocs-material 5.0.0rc3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs-material-5.0.0rc3.tar.gz | 1.4 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_material-5.0.0rc3-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 4.4 MB
Release files / mkdocs-material-5.0.0rc3.tar.gz
| Download URL | mkdocs-material-5.0.0rc3.tar.gz |
|---|---|
| Size | 1.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
abc3d51ac6c9a84e0bf2a9da4b642310dea385e694e561daf9982c0739793c2b
|
|
BLAKE2b-256 checksum How to use checksums |
1bc6f58009aa7a9fea0317bd993a117d292d3fb314f92cf32e0141296b61146a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
|
Release files / mkdocs_material-5.0.0rc3-py2.py3-none-any.whl
| Download URL | mkdocs_material-5.0.0rc3-py2.py3-none-any.whl |
|---|---|
| Size | 3.0 MB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
16d87f2f8cb1186c05c05bfa1a1fadb05e0361d2d6149a98f976c973d2cee3b3
|
|
BLAKE2b-256 checksum How to use checksums |
058085ab298b01489fc844b32dcdb8183a701f600c722b63fcbd52ccefcbbd45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
|
