hugo-coder-fork/README.md

13 lines
1.0 KiB
Markdown

Forked from [hugo-coder](https://github.com/luizdepra/hugo-coder) - a simple and clean blog theme for [Hugo](https://gohugo.io/).
## Quick Start
1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://git.rayelliott.dev/rayelliott/hugo-coder-fork.git themes/hugo-coder`.
2. Configure your `config.toml`. You can either use the [this minimal configuration](https://github.com/luizdepra/hugo-coder/wiki/Configurations#complete-example) as a base, or look for a complete explanation about all configurations [here](https://github.com/luizdepra/hugo-coder/wiki/Configurations). The [`config.toml`](https://github.com/luizdepra/hugo-coder/blob/master/exampleSite/config.toml) inside the [`exampleSite`](https://github.com/luizdepra/hugo-coder/tree/master/exampleSite) is also a good reference.
3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`.
## License
Coder is licensed under the [MIT license](https://git.rayelliott.dev/rayelliott/hugo-coder-fork/src/branch/master/LICENSE.md).