templates for self-hosting game jams (or any other kind of jam tbh)
veryroundbird.house
1# Hugo ʕ•ᴥ•ʔ Bear Blog [](https://github.com/janraasch/hugo-bearblog/actions/workflows/ci.yml)
2
3🧸 A [Hugo](https://gohugo.io/)-theme based on [Bear Blog](https://bearblog.dev).
4
5> Free, no-nonsense, super-fast blogging.
6
7## Demo
8
9For a current & working demo of this theme, please check out https://janraasch.github.io/hugo-bearblog/ 🎯.
10
11## Screenshots
12
13⬜️ [Light][light-screenshot]
14
15⬛️ [Dark][dark-screenshot]
16
17When the user's browser is running »dark mode«, the dark color scheme will be used automatically. The default is the light/white color scheme. Check out the [`style.html`](https://github.com/janraasch/hugo-bearblog/blob/master/layouts/partials/style.html)-file for the implementation.
18
19## Installation
20
21If you already have a Hugo site on your machine, you can simply add this theme via
22
23```bash
24git submodule add https://github.com/janraasch/hugo-bearblog.git themes/hugo-bearblog
25```
26
27Then, adjust the `hugo.toml` as detailed below.
28
29For more information, read the official [setup guide][hugo-setup-guide] of Hugo.
30
31## Adjust configuration / hugo.toml
32
33Please check out the [hugo.toml](https://github.com/janraasch/hugo-bearblog/blob/master/exampleSite/hugo.toml) included in the [exampleSite](https://github.com/janraasch/hugo-bearblog/tree/master/exampleSite) of this theme.
34
35## Content & structure
36
37### Starting fresh
38
39If you are starting fresh, simply copy over the contents of the `exampleSite`-directory included in this theme to your source directory. That should give you a good idea about how things work, and then you can go on from there to make the site your own.
40
41### Adding / editing content
42
43#### Index-Page
44
45The contents of the `index`-page may be changed by editing your `content/_index.md`-file.
46
47#### Page
48
49You can add **a new page** via running
50
51```bash
52hugo new my-new-page.md
53```
54
55#### Blog-Post
56
57You can add **a new blog-post** via running
58
59```bash
60hugo new blog/my-new-post.md
61```
62
63### Adding your branding / colors / css
64
65Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `<style>`-tag, *or* you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Check out the [`style.html`](https://github.com/janraasch/hugo-bearblog/blob/master/layouts/partials/style.html)-file to find out which CSS-styles are applied by default.
66
67## Remixes 🎭
68
69The community has created some interesting variations of Hugo ʕ•ᴥ•ʔ Bear Blog. While the main theme stays true to the minimal Bear Blog philosophy, these remixes experiment with additional features:
70
71* [Hugo ʕ•ᴥ•ʔ Bear Blog ✨ Neo](https://github.com/rokcso/hugo-bearblog-neo/) - Features Chinese documentation and an innovative "Toast" upvote system.
72
73* [ᕦʕ •ᴥ•ʔᕤ Bear Cub](https://github.com/clente/hugo-bearcub) - A multilingual variant with experimental features like automatic social card generation.
74
75_Note: These are independent forks maintained by their respective creators._
76
77## Contributing & Community 🤝
78
79Interested in contributing to Hugo ʕ•ᴥ•ʔ Bear Blog? Thanks for your interest!
80
81- Check out our [Contributing Guidelines](CONTRIBUTING.md) for code contributions and bug reports
82- [Share your story](https://github.com/janraasch/hugo-bearblog/issues/new/choose) if you're using the theme - we'd love to see what you've built!
83- Have questions? You can find help in our [GitHub issues](https://github.com/janraasch/hugo-bearblog/issues) or the [Hugo Discourse](https://discourse.gohugo.io/)
84
85We aim to keep this theme as simple and fast as the original [Bear Blog](https://bearblog.dev), while making it a friendly space for everyone to contribute and share their experiences.
86
87## Development
88Run the `exampleSite` locally via
89
90```bash
91hugo server --source ./exampleSite --themesDir ../..
92```
93
94In case you want to test functionalities and use hugo commands, in the root directory, you'll have to append `--source ./exampleSite --themesDir ../..` to them.
95
96For example:
97
98```bash
99hugo new blog/post.md --source ./exampleSite --themesDir ../..
100```
101
102Same thing for pages:
103
104```bash
105hugo new page.md --source ./exampleSite --themesDir ../..
106```
107
108## Special Thanks 🎁
109
110A special thank you goes out to [Herman](https://herman.bearblog.dev), for creating the original [ʕ•ᴥ•ʔ Bear Blog](https://bearblog.dev/).
111
112## License
113[MIT License](http://en.wikipedia.org/wiki/MIT_License) © [Jan Raasch](https://www.janraasch.com)
114
115[hugo-setup-guide]: https://gohugo.io/getting-started/installing
116[light-screenshot]: https://raw.githubusercontent.com/janraasch/hugo-bearblog/master/images/screenshot.png
117[dark-screenshot]: https://raw.githubusercontent.com/janraasch/hugo-bearblog/master/images/screenshot-dark.png