Skip to main content

A fork of Material Design theme for MkDocs for Rokubun

Project description

Material for MkDocs

A Material Design theme for MkDocs

GitHub Action Downloads Chat on Gitter Python Package Index Docker Pulls

Create a branded static site from a set of Markdown files to host the documentation of your Open Source or commercial project – customizable, searchable, mobile-friendly, 40+ languages. Set up in 5 minutes.

A demo is worth a thousand words — check it out at squidfunk.github.io/mkdocs-material.

Features

  • It's just Markdown — write your technical documentation in plain Markdown – no need to know HTML, JavaScript, or CSS. Material for MkDocs will do the heavy lifting and convert your writing to a beautiful and functional website.

  • Responsive by design — built from the ground up to work on all sorts of devices – from mobile phones to widescreens. The underlying fluid layout will always adapt perfectly to the available screen space.

  • Static, yet searchable — almost magically, your technical documentation website will be searchable without any further ado. Material for MkDocs comes with built-in search – no server needed – that will instantly answer your users' queries.

  • Many configuration options — change the color palette, font families, language, icons, favicon and logo. Add a source repository link, links to your social profiles, Google Analytics and Disqus - all with a few lines of code.

  • Truly international — thanks to many contributors, Material for MkDocs includes translations for more than 40 languages and offers full native RTL (right-to-left) support for languages such as Arabic, Persian (Farsi) and Hebrew.

  • Accessible — Material for MkDocs provides extensible keyboard navigation and semantic markup including role attributes and landmarks. Furthermore, the layout is entirely based on rem values, respecting the user's default font size.

  • Beyond GitHub Markdown — integrates natively with Python Markdown Extensions, offering additional elements like callouts, tabbed content containers, mathematical formulas, critic markup, task lists, and emojis.

  • Modern architecture — Material for MkDocs's underlying codebase is built with TypeScript, RxJS, and SCSS, and is compiled with Webpack, bringing excellent possibilities for theme extension and customization.

Material for MkDocs uses the sponsorware release strategy, which means that new features are first exclusively released to sponsors as part of Material for MkDocs Insiders. Read on to learn how sponsorship works, and how you can become a sponsor.

Quick start

Material for MkDocs can be installed with pip:

pip install mkdocs-material

Add the following line to mkdocs.yml:

theme:
  name: material

For other installation methods, configuration options, and a demo, visit squidfunk.github.io/mkdocs-material

Sponsors

Users

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


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-5.5.12.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

mkdocs_rokubun-5.5.12-py2.py3-none-any.whl (3.9 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: mkdocs-rokubun-5.5.12.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • 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-5.5.12.tar.gz
Algorithm Hash digest
SHA256 911da4e51538381812de873756acdb6103861eb4d66f7d53c97a450b28ec6697
MD5 fda0829ee446d04d486f1f9a1e40cd80
BLAKE2b-256 d91f904e9a535935f8ece13a287e5c2b19aaece0c7206e48ec8db731952895a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_rokubun-5.5.12-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.9 MB
  • 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-5.5.12-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 825ed95cfb7dba01a10b1aacd639289e6e542cbedf0694aac43a1294b2c9fa02
MD5 cf823bb69a0a59576eaeb8b0258e99f6
BLAKE2b-256 5b2a98074bb7d955f530bc46e0c0f12430e0551a29d19c012dbace3b73aed7a1

See more details on using hashes here.

Supported by

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