Skip to main content

A fork of Material Design theme for MkDocs for Rokubun

Project description

Travis Downloads Gitter PyPI dependabot

Material for MkDocs

This is a fork of the amazing Mkdocs material theme for Rokubun

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 38 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/

License

MIT License

Copyright (c) 2016-2019 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


Download files

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

Source Distribution

mkdocs-rokubun-4.4.2.tar.gz (682.3 kB view details)

Uploaded Source

Built Distribution

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

mkdocs_rokubun-4.4.2-py2.py3-none-any.whl (715.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mkdocs-rokubun-4.4.2.tar.gz.

File metadata

  • Download URL: mkdocs-rokubun-4.4.2.tar.gz
  • Upload date:
  • Size: 682.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.0.3 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for mkdocs-rokubun-4.4.2.tar.gz
Algorithm Hash digest
SHA256 d6792f89f4261565d9570fcf17a3a032db36dffe1ebbe87a61587b2da7832d86
MD5 78dec63169faf05ea6511a3123487426
BLAKE2b-256 149cec6afd844d22c94282171a2bb9905b0702ce1e8be187ebf774bcbd265c7b

See more details on using hashes here.

File details

Details for the file mkdocs_rokubun-4.4.2-py2.py3-none-any.whl.

File metadata

  • Download URL: mkdocs_rokubun-4.4.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 715.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.0.3 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for mkdocs_rokubun-4.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a71673a6bac73a50d2d275795ab343b01466a4811718f002c1b3c84d70c4f7d7
MD5 74f446cc72475264e27325fa1971d7fd
BLAKE2b-256 7e97d5e7b36b2d3e4209bb29d2d730ea85df8890869964613fc90d9f70b4e65b

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