Public | Automated Build

Last pushed: 4 days ago
Short Description
A Material Design theme for MkDocs
Full Description

Material for MkDocs

A Material Design theme for MkDocs.

Usage

Add the following line to your mkdocs.yml:

theme: 'material'

Mount the folder where your mkdocs.yml resides as a volume into /docs:

  • Start development server on http://localhost:8000

    docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material
    
  • Build documentation

    docker run --rm -it -v `pwd`:/docs squidfunk/mkdocs-material build
    
  • Deploy documentation to GitHub Pages

    docker run --rm -it -v `pwd`:/docs squidfunk/mkdocs-material gh-deploy
    

For detailed installation instructions and a demo, visit
http://squidfunk.github.io/mkdocs-material/

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.

Docker Pull Command
Owner
squidfunk
Source Repository

Comments (0)