/mkdocs-material

A Material Design theme for MkDocs
mkdocs theme documentation material-design template static
  1. HTML 39.3%
  2. CSS 34.3%
  3. JavaScript 23.8%
  4. Shell 1.1%
  5. Makefile 0.6%
  6. Python 0.5%
  7. Dockerfile 0.4%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

@dependabot-bot @dependabot
dependabot-bot and dependabot Bump copy-webpack-plugin from 4.6.0 to 5.0.0 
Bumps [copy-webpack-plugin](https://github.com/webpack-contrib/copy-webpack-plugin) from 4.6.0 to 5.0.0.
- [Release notes](https://github.com/webpack-contrib/copy-webpack-plugin/releases)
- [Changelog](https://github.com/webpack-contrib/copy-webpack-plugin/blob/master/CHANGELOG.md)
- [Commits](webpack-contrib/copy-webpack-plugin@v4.6.0...v5.0.0)

Signed-off-by: dependabot[bot] <support@dependabot.com>
Latest commit 38a375b Feb 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Added mkdocs.yml as a requirement to issue template Jan 22, 2017
docs Prepare 4.0.1 release Feb 13, 2019
material Prepare 4.0.1 release Feb 13, 2019
src Fixed glitch in sidebar when collapsing items Feb 13, 2019
.babelrc Upgraded to webpack 4 (#941) Dec 28, 2018
.editorconfig Updated copyright year Jan 1, 2019
.env Updated copyright year Jan 1, 2019
.eslintignore Updated copyright year Jan 1, 2019
.eslintrc Upgraded to webpack 4 (#941) Dec 28, 2018
.gitignore Updated copyright year Jan 1, 2019
.modernizr-autorc Refactored Gulp build pipeline with Webpack Nov 21, 2017
.stylelintignore Updated copyright year Jan 1, 2019
.stylelintrc Fixed stylelint errors Feb 12, 2019
.travis.sh Updated copyright year Jan 1, 2019
.travis.yml Updated copyright year Jan 1, 2019
.travisignore Remove .travisignore from .travisignore Apr 8, 2017
CHANGELOG Prepare 4.0.1 release Feb 13, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 21, 2017
CONTRIBUTING.md Fixed protocol for links in documentation Jun 11, 2018
Dockerfile Updated copyright year Jan 1, 2019
LICENSE Updated copyright year Jan 1, 2019
MANIFEST.in Try to fix Travis build Jun 10, 2018
Makefile Updated copyright year Jan 1, 2019
README.md Added Greek translations Feb 13, 2019
mkdocs.yml Prepare 3.3.0 release Jan 29, 2019
package-lock.json Bump copy-webpack-plugin from 4.6.0 to 5.0.0 Feb 20, 2019
package.json Bump copy-webpack-plugin from 4.6.0 to 5.0.0 Feb 20, 2019
requirements.txt Updated copyright year Jan 1, 2019
setup.py Updated copyright year Jan 1, 2019
webpack.config.js Updated copyright year Jan 1, 2019

README.md

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-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 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://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.