A Material Design theme for MkDocs

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for squidfunk from gravatar.com squidfunk

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Martin Donath
  • Tags mkdocs , documentation , theme
Classifiers
Report project as malware

Project description

Github Action Downloads Gitter PyPI dependabot

Material for MkDocs

⚠️ Help test Material 5!

A Material Design theme for MkDocs.

Material 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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for squidfunk from gravatar.com squidfunk

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Martin Donath
  • Tags mkdocs , documentation , theme
Classifiers

Release history Release notifications | RSS feed

9.6.15

9.6.14

9.6.13

9.6.12

9.6.11

9.6.10

9.6.9

9.6.8

9.6.7

9.6.6

9.6.5

9.6.4

9.6.3

9.6.2

9.6.1

9.6.0

9.5.50

9.5.49

9.5.48

9.5.47

9.5.46

9.5.45

9.5.44

9.5.43

9.5.42

9.5.41

9.5.40

9.5.39

9.5.38

9.5.37

9.5.36

9.5.35

9.5.34

9.5.33

9.5.32

9.5.31

9.5.30

9.5.29

9.5.28

9.5.27

9.5.26

9.5.25

9.5.24

9.5.23

9.5.22

9.5.21

9.5.20

9.5.19

9.5.18

9.5.17

9.5.16

9.5.15

9.5.14

9.5.13

9.5.12

9.5.11

9.5.10

9.5.9

9.5.8

9.5.7

9.5.6

9.5.5

9.5.4

9.5.3

9.5.2

9.5.1

9.5.0

9.4.14

9.4.13

9.4.12

9.4.11

9.4.10

9.4.9

9.4.8

9.4.7

9.4.6

9.4.5

9.4.4

9.4.3

9.4.2

9.4.1

9.4.0

9.3.2

9.3.1

9.3.0

9.2.8

9.2.7

9.2.6

9.2.5

9.2.4

9.2.3

9.2.2

9.2.1

9.2.0

9.2.0b3 pre-release

9.2.0b2 pre-release

9.2.0b1 pre-release

9.2.0b0 pre-release

9.1.21

9.1.20

9.1.19

9.1.18

9.1.17

9.1.16

9.1.15

9.1.14

9.1.13

9.1.12

9.1.11

9.1.10

9.1.9

9.1.8

9.1.7

9.1.6

9.1.5

9.1.4

9.1.3

9.1.2

9.1.1

9.1.0

9.0.15

9.0.14

9.0.13

9.0.12

9.0.11

9.0.10

9.0.9

9.0.8

9.0.7

9.0.6

9.0.5

9.0.4

9.0.3

9.0.2

9.0.1

9.0.0

9.0.0b4 pre-release

9.0.0b3 pre-release

9.0.0b2 pre-release

9.0.0b1 pre-release

8.5.11

8.5.10

8.5.9

8.5.8

8.5.7

8.5.6

8.5.5

8.5.4

8.5.3

8.5.2

8.5.1

8.5.0

8.4.4

8.4.3

8.4.2

8.4.1

8.4.0

8.4.0rc1 pre-release

8.3.9

8.3.8

8.3.7

8.3.6

8.3.5

8.3.4

8.3.3

8.3.2

8.3.1

8.3.0

8.2.16

8.2.15

8.2.14

8.2.13

8.2.12

8.2.11

8.2.10

8.2.9

8.2.8

8.2.7

8.2.6

8.2.5

8.2.4

8.2.3

8.2.2

8.2.1

8.2.0

8.1.11

8.1.10

8.1.9

8.1.8

8.1.7

8.1.6

8.1.5

8.1.4

8.1.3

8.1.2

8.1.1

8.1.0

8.0.5

8.0.4

8.0.3

8.0.2

8.0.1

8.0.0

8.0.0b2 pre-release

8.0.0b1 pre-release

7.3.6

7.3.5

7.3.4

7.3.3

7.3.2

7.3.1

7.3.0

7.2.8

7.2.7

7.2.6

7.2.5

7.2.4

7.2.3

7.2.2

7.2.1

7.2.0

7.1.11

7.1.10

7.1.9

7.1.8

7.1.7

7.1.6

7.1.5

7.1.4

7.1.3

7.1.2

7.1.1

7.1.0

7.0.7

7.0.6

7.0.5

7.0.4

7.0.3

7.0.2

7.0.1

7.0.0

7.0.0b2 pre-release

7.0.0b1 pre-release

6.2.8

6.2.7

6.2.6

6.2.5

6.2.4

6.2.3

6.2.2

6.2.1

6.2.0

6.1.7

6.1.6

6.1.5

6.1.4

6.1.3

6.1.2

6.1.1

6.1.0

6.0.2

6.0.1

6.0.0

5.5.14

5.5.13

5.5.12

5.5.11

5.5.10

5.5.9

5.5.8

5.5.7

5.5.6

5.5.5

5.5.4

5.5.3

5.5.2

5.5.1

5.5.0

5.4.0

5.3.3

5.3.2

5.3.1

5.3.0

5.2.3

5.2.2

5.2.1

5.2.0

5.1.7

5.1.6

5.1.5

5.1.4

5.1.3

5.1.2

5.1.1

5.1.0

5.0.2

5.0.1

5.0.0

5.0.0rc4 pre-release

This version

5.0.0rc3 pre-release

5.0.0rc2 pre-release

5.0.0rc1 pre-release

5.0.0b3.post2 pre-release

5.0.0b3.post1 pre-release

5.0.0b3 pre-release

5.0.0b2.post1 pre-release

5.0.0b2 pre-release

5.0.0b1 pre-release

4.6.3

4.6.2

4.6.1

4.6.0

4.5.1

4.5.0

4.4.3

4.4.2

4.4.1

4.4.0

4.3.1

4.3.0

4.2.0

4.1.2

4.1.1

4.1.0

4.0.2

4.0.1

4.0.0

3.3.0

3.2.0

3.1.0

3.0.6

3.0.5

3.0.4

3.0.3

3.0.2

3.0.1

3.0.0

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.0

2.7.3

2.7.2

2.7.1

2.7.0

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.0

2.3.0

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.1

2.1.0

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.12.2

1.12.1

1.12.0

1.11.0

1.10.4

1.10.3

1.10.2

1.10.1

1.10.0

1.9.0

1.8.1

1.8.0

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.1

1.4.0

1.3.0

1.2.0

1.1.1

1.1.0

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.3

0.1.2

0.1.1

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-material-5.0.0rc3.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

mkdocs_material-5.0.0rc3-py2.py3-none-any.whl (3.0 MB view details)

Uploaded Python 2Python 3

File details

Details for the file mkdocs-material-5.0.0rc3.tar.gz.

File metadata

  • Download URL: mkdocs-material-5.0.0rc3.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for mkdocs-material-5.0.0rc3.tar.gz
Algorithm Hash digest
SHA256 abc3d51ac6c9a84e0bf2a9da4b642310dea385e694e561daf9982c0739793c2b
MD5 e4fff1918e67561d27498cd6c9ca10be
BLAKE2b-256 1bc6f58009aa7a9fea0317bd993a117d292d3fb314f92cf32e0141296b61146a

See more details on using hashes here.

File details

Details for the file mkdocs_material-5.0.0rc3-py2.py3-none-any.whl.

File metadata

  • Download URL: mkdocs_material-5.0.0rc3-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.0 MB
  • Tags: Python 2, Python 3
  • Uploaded using 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

File hashes

Hashes for mkdocs_material-5.0.0rc3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 16d87f2f8cb1186c05c05bfa1a1fadb05e0361d2d6149a98f976c973d2cee3b3
MD5 b77ecfaf8c2c9f278a9bc9c0e482871d
BLAKE2b-256 058085ab298b01489fc844b32dcdb8183a701f600c722b63fcbd52ccefcbbd45

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page