summaryrefslogtreecommitdiff
path: root/themes/hugo-coder/README.md
diff options
context:
space:
mode:
authorRyan Schanzenbacher <ryan@rschanz.org>2021-12-26 00:30:09 -0500
committerRyan Schanzenbacher <ryan@rschanz.org>2021-12-26 00:30:09 -0500
commit8555cf72dec9321fa010296ce6988cf7b7cf602b (patch)
tree006ad83008cc8e08524631ebb4b638bfbfa490fd /themes/hugo-coder/README.md
parent2e1cd1a569ea516be6bfdc681411cae51632a290 (diff)
convert theme from submodule to regular files
Diffstat (limited to 'themes/hugo-coder/README.md')
m---------themes/hugo-coder0
-rw-r--r--themes/hugo-coder/README.md59
2 files changed, 59 insertions, 0 deletions
diff --git a/themes/hugo-coder b/themes/hugo-coder
deleted file mode 160000
Subproject 55b2a150f990bc56364dba347bc9acc6aab07be
diff --git a/themes/hugo-coder/README.md b/themes/hugo-coder/README.md
new file mode 100644
index 0000000..ceb2c40
--- /dev/null
+++ b/themes/hugo-coder/README.md
@@ -0,0 +1,59 @@
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
18A simple and clean blog theme for [Hugo](https://gohugo.io/).
19
20![](https://github.com/luizdepra/hugo-coder/blob/master/images/screenshot.png)
21
22## Live Demo
23
24See [here](https://hugo-coder.netlify.app/).
25
26## Quick Start
27
281. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/luizdepra/hugo-coder.git themes/hugo-coder`.
292. 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.
303. 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
38This 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[![Create with Stackbit](https://assets.stackbit.com/badge/create-with-stackbit.svg)](https://app.stackbit.com/create?theme=https://github.com/luizdepra/hugo-coder)
41
42## License
43
44Coder is licensed under the [MIT license](https://github.com/luizdepra/hugo-coder/blob/master/LICENSE.md).
45
46## Maintenance
47
48This 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
52If 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.