github.com/google/cloudprober@v0.11.3/docs/themes/hugo-material-docs/README.md (about)

     1  # Material Docs
     2  
     3  A material design theme for [Hugo](https://gohugo.io).
     4  
     5  [![Screenshot](https://raw.githubusercontent.com/digitalcraftsman/hugo-material-docs/master/static/images/screen.png)](https://digitalcraftsman.github.io/hugo-material-docs/)
     6  
     7  ## Quick start
     8  
     9  Install with `git`:
    10  
    11  
    12      git clone https://github.com/digitalcraftsman/hugo-material-docs.git themes/hugo-material-docs
    13  
    14  
    15  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. 
    16  
    17  Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary. 
    18  
    19  Hugo includes a development server, so you can view your changes as you go -
    20  very handy. Spin it up with the following command:
    21  
    22  ``` sh
    23  hugo server
    24  ```
    25  
    26  Now you can go to [localhost:1313](http://localhost:1313) and the Material
    27  theme should be visible. For detailed installation instructions visit the [demo](http://themes.gohugo.io/theme/material-docs/).
    28  
    29  Noteworthy changes of this theme are listed in the [changelog](https://github.com/digitalcraftsman/hugo-material-docs/blob/master/CHANGELOG.md).
    30  
    31  ## Acknowledgements
    32  
    33  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.
    34  
    35  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.
    36  
    37  ## License
    38  
    39  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.
    40