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

Uploaded Source

Built Distribution

mkdocs_brudi-0.4.1-py2.py3-none-any.whl (705.6 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: mkdocs-brudi-0.4.1.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.1.tar.gz
Algorithm Hash digest
SHA256 35bc5bd148517fa7d8c9e15867b2e7aee1930287ebd29559cfdacdd374b9492f
MD5 f696eb75196c39358aa1912a0f38d10b
BLAKE2b-256 e5c629ab204a42e25b95141740b782ab099c470578f058910f7f3cb2c0d61a86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_brudi-0.4.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 705.6 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.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 259037e46b3dedf5a12ff71cc1cb002b3c922b0202c136ea343b2ee798af43c5
MD5 0ec2e54b645c207a82f11b93580b61df
BLAKE2b-256 3aa575b184b51aec5d746682cd979f678bd3a8cc3b31e0298fc67c5826522b03

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