blackbirdchess/blackbirdchess-docker-dev

History

Mahmoud Zalt f91ffcfd20 move the readme.md content to hugo site		2017-02-22 14:59:06 -05:00
..
archetypes	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00
exampleSite	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00
images	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00
layouts	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00
static	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00
CHANGELOG.md	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00
LICENSE.md	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00
README.md	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00
theme.toml	move the readme.md content to hugo site	2017-02-22 14:59:06 -05:00

README.md

Material Docs

A material design theme for Hugo.

Quick start

Install with git:

git clone https://github.com/digitalcraftsman/hugo-material-docs.git themes/hugo-material-docs

Next, take a look in the exampleSite folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation.

Copy at least the config.toml in the root directory of your website. Overwrite the existing config file if necessary.

Hugo includes a development server, so you can view your changes as you go - very handy. Spin it up with the following command:

hugo server

Now you can go to localhost:1313 and the Material theme should be visible. For detailed installation instructions visit the demo.

Noteworthy changes of this theme are listed in the changelog.

Acknowledgements

A big thank you to Martin Donath. He created the original Material theme for Hugo's companion MkDocs. This port wouldn't be possible without him.

Furthermore, thanks to Steve Francia for creating Hugo and the awesome community around the project.

License

The theme is released under the MIT license. Read the license for more information.