41 lines
1.8 KiB
Markdown
41 lines
1.8 KiB
Markdown
|
# Material Docs
|
||
|
|
|
||
|
|
A material design theme for [Hugo](https://gohugo.io).
|
||
|
|
|
||
|
|
[](https://digitalcraftsman.github.io/hugo-material-docs/)
|
||
|
|
|
||
|
|
## 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:
|
||
|
|
|
||
|
|
``` sh
|
||
|
|
hugo server
|
||
|
|
```
|
||
|
|
|
||
|
|
Now you can go to [localhost:1313](http://localhost:1313) and the Material
|
||
|
|
theme should be visible. For detailed installation instructions visit the [demo](http://themes.gohugo.io/theme/material-docs/).
|
||
|
|
|
||
|
|
Noteworthy changes of this theme are listed in the [changelog](https://github.com/digitalcraftsman/hugo-material-docs/blob/master/CHANGELOG.md).
|
||
|
|
|
||
|
|
## Acknowledgements
|
||
|
|
|
||
|
|
A big thank you to [Martin Donath](https://github.com/squidfunk). He created the original [Material theme](https://github.com/squidfunk/mkdocs-material) for Hugo's companion [MkDocs](http://www.mkdocs.org/). This port wouldn't be possible without him.
|
||
|
|
|
||
|
|
Furthermore, thanks to [Steve Francia](https://gihub.com/spf13) for creating Hugo and the [awesome community](https://github.com/spf13/hugo/graphs/contributors) around the project.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
The theme is released under the MIT license. Read the [license](https://github.com/digitalcraftsman/hugo-material-docs/blob/master/LICENSE.md) for more information.
|
||
|
|
|