https://github.com/digitalcraftsman/hugo-material-docs

Port of Martin Donath's mkdocs-material theme to Hugo
https://github.com/digitalcraftsman/hugo-material-docs

Last synced: 5 days ago
JSON representation

Port of Martin Donath's mkdocs-material theme to Hugo

• Host: GitHub
• URL: https://github.com/digitalcraftsman/hugo-material-docs
• Owner: digitalcraftsman
• License: mit
• Archived: true
• Created: 2016-03-08T23:10:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-07-08T14:13:13.000Z (over 3 years ago)
• Last Synced: 2024-08-02T18:41:48.230Z (3 months ago)
• Language: HTML
• Homepage:
• Size: 825 KB
• Stars: 705
• Watchers: 25
• Forks: 188
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome - hugo-material-docs - Port of Martin Donath's mkdocs-material theme to Hugo (HTML)

README

        
# Material Docs

## Please note that this theme is no longer maintained.

A material design theme for [Hugo](https://gohugo.io).

[![Screenshot](https://raw.githubusercontent.com/digitalcraftsman/hugo-material-docs/master/static/images/screen.png)](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.