Skip to main content

Custom Material Design theme for MkDocs

Project description

Travis Codacy PyPI

Custom Material Theme for MkDocs

A custom Material Design theme for MkDocs.

Material for MkDocs

Quick start

Install the latest version of Material with pip:

pip install mkdocs-unidata

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

theme: 'unidata'
conda env create -f environment.yml
source activate mkdocs-unidata
mkdocs serve

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 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 http://mjames-upc.github.io/mkdocs-unidata/

License

MIT License

Copyright (c) 2016-2017 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-unidata-2.0.3.tar.gz (95.7 kB view details)

Uploaded Source

Built Distribution

mkdocs_unidata-2.0.3-py3-none-any.whl (112.1 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs-unidata-2.0.3.tar.gz.

File metadata

  • Download URL: mkdocs-unidata-2.0.3.tar.gz
  • Upload date:
  • Size: 95.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for mkdocs-unidata-2.0.3.tar.gz
Algorithm Hash digest
SHA256 56d23b0a031d3bc0da9c835d8e6133ae20cf1bc558b4b5d351f759065e9b5e4b
MD5 6d698a0aa200c55dff0c773110986d67
BLAKE2b-256 1bd25768f65eb312483850dd79f86b7b758e6022b4d2ffebc85e6aad4cdc18cd

See more details on using hashes here.

File details

Details for the file mkdocs_unidata-2.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_unidata-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3c2c342ed01d5d5c04cce9e099a402733a2ff37f17c084d5fca1d076ae1917ad
MD5 7099721cc9b7ec6e8a77a5c00a5e31f4
BLAKE2b-256 8ce075fd565d41b948a51290f6063661494fca1e645c44245e968049b1742c4a

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