Skip to main content

A brudi theme for MkDocs based on mkdocs-brudi

Project description

Travis 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-brudi

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

theme:
  name: 'brudi'

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 35 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://github.com/brudi/mkdocs-brudi/

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-brudi-0.4.2.tar.gz (652.6 kB view details)

Uploaded Source

Built Distribution

mkdocs_brudi-0.4.2-py2.py3-none-any.whl (681.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mkdocs-brudi-0.4.2.tar.gz.

File metadata

  • Download URL: mkdocs-brudi-0.4.2.tar.gz
  • Upload date:
  • Size: 652.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for mkdocs-brudi-0.4.2.tar.gz
Algorithm Hash digest
SHA256 7d9863b7f21674f6c7dfaec342e53002613c9355080e84a54d49359e5349d771
MD5 8f5b3afcf724f1498da2b63c39bec11d
BLAKE2b-256 4367e1cc61af27e2d46d5a0f8d080ac82a84afa7f57ffe973a5c5d933b56fd7d

See more details on using hashes here.

File details

Details for the file mkdocs_brudi-0.4.2-py2.py3-none-any.whl.

File metadata

  • Download URL: mkdocs_brudi-0.4.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 681.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for mkdocs_brudi-0.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 280d7e24ff7a24221c7852ac56d09c1478439c1c48ac5d25ef7def51f2930f6e
MD5 39be3eb6cbbcea969fdd67e09d9bbf7a
BLAKE2b-256 efe1174cdd55284dc8e55b0b699d0346b8b7f70d03f145c5bb985cc3c97cddcf

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