quick-start.md (1212B)
1 # Quick Start 2 3 To start using `hugo-coder`: 4 5 1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/luizdepra/hugo-coder.git themes/coder`. 6 2. Configure your `hugo.toml`. You can use [this minimal configuration](https://github.com/luizdepra/hugo-coder/blob/main/docs/configurations.md#complete-example) as a base. The [`hugo.toml`](https://github.com/luizdepra/hugo-coder/blob/master/exampleSite/hugo.toml) inside the [exampleSite](https://github.com/luizdepra/hugo-coder/tree/master/exampleSite) from the `exampleSite` is also a good reference. 7 3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`. 8 9 If you just want to test this theme, go to [this page](https://themes.gohugo.io/themes/hugo-coder/). 10 11 You can also clone or download it, then run these commands: 12 13 ``` 14 git clone https://github.com/luizdepra/hugo-coder.git 15 16 cd hugo-coder 17 18 make demo 19 ``` 20 21 You'll see the result at [http://localhost:1313/](http://localhost:1313/). 22 23 > These last two methods don't use the same content directory, the first one leads to 404 pages for some pages. More info [here](https://github.com/gohugoio/hugoThemes#adding-a-theme-to-the-list).