themes/hugo-coder/README.md
main
· 2.7 KB · 59 lines
raw
| 1 | <p align="center"> |
| 2 | <p align="center"> |
| 3 | <a href="https://themes.gohugo.io/hugo-coder/"> |
| 4 | <img src="https://img.shields.io/badge/theme-hugo--coder-2b8cbe" alt="Hugo Theme Badge""> |
| 5 | </a> |
| 6 | <a href="https://github.com/luizdepra/hugo-coder/blob/master/LICENSE.txt"> |
| 7 | <img src="https://img.shields.io/github/license/luizdepra/hugo-coder.svg" alt="MIT License Badge"> |
| 8 | </a> |
| 9 | </p> |
| 10 | |
| 11 | <p align="center"> |
| 12 | <a href="https://github.com/luizdepra/hugo-coder"> |
| 13 | <img src="images/logos/logotype-a.png" alt="Hugo Coder Logo" width="600px" height="184px"> |
| 14 | </a> |
| 15 | </p> |
| 16 | </p> |
| 17 | |
| 18 | A simple and clean blog theme for [Hugo](https://gohugo.io/). |
| 19 | |
| 20 |  |
| 21 | |
| 22 | ## Live Demo |
| 23 | |
| 24 | See [here](https://hugo-coder.netlify.app/). |
| 25 | |
| 26 | ## Quick Start |
| 27 | |
| 28 | 1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/luizdepra/hugo-coder.git themes/hugo-coder`. |
| 29 | 2. Configure your `config.toml`. You can either use [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. |
| 30 | 3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`. |
| 31 | |
| 32 | ## Extra Guides |
| 33 | |
| 34 | * [Multilingual Mode](https://github.com/luizdepra/hugo-coder/wiki/Multilingual-Mode) |
| 35 | |
| 36 | ## Stackbit |
| 37 | |
| 38 | This theme is ready to import into Stackbit. This theme can be deployed to Netlify and you can connect any headless CMS including Forestry, NetlifyCMS, DatoCMS or Contentful. |
| 39 | |
| 40 | [](https://app.stackbit.com/create?theme=https://github.com/luizdepra/hugo-coder) |
| 41 | |
| 42 | ## License |
| 43 | |
| 44 | Coder is licensed under the [MIT license](https://github.com/luizdepra/hugo-coder/blob/master/LICENSE.md). |
| 45 | |
| 46 | ## Maintenance |
| 47 | |
| 48 | This theme is maintained by its author [Luiz de Prá](https://github.com/luizdepra) with the help from these awesome [contributors](CONTRIBUTORS.md). |
| 49 | |
| 50 | ## Sponsoring |
| 51 | |
| 52 | If you like my project or it was useful for you, consider supporting its development. Just: |
| 53 | |
| 54 | <a href="https://www.buymeacoffee.com/luizdepra" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-green.png" alt="Buy Me A Coffee" height="41" width="174"></a> |
| 55 | |
| 56 | ## Special Thanks |
| 57 | |
| 58 | - Gleen McComb, for his great [article](https://glennmccomb.com/articles/how-to-build-custom-hugo-pagination/) about custom pagination. |
| 59 | - All contributors, for every PR and Issue reported. |