diff options
Diffstat (limited to 'themes/hugo-bearblog/README.md')
| m--------- | themes/hugo-bearblog | 0 | ||||
| -rw-r--r-- | themes/hugo-bearblog/README.md | 86 |
2 files changed, 86 insertions, 0 deletions
diff --git a/themes/hugo-bearblog b/themes/hugo-bearblog deleted file mode 160000 -Subproject efc24bc5e95f0ccb88051e1a7d95e8a1404e953 diff --git a/themes/hugo-bearblog/README.md b/themes/hugo-bearblog/README.md new file mode 100644 index 0000000..ab0a75e --- /dev/null +++ b/themes/hugo-bearblog/README.md @@ -0,0 +1,86 @@ +# Hugo ʕ•ᴥ•ʔ Bear Blog  + +🧸 A [Hugo](https://gohugo.io/)-theme based on [Bear Blog](https://bearblog.dev). + +> Free, no-nonsense, super-fast blogging. + +## Demo + +For a current & working demo of this theme, please check out https://janraasch.github.io/hugo-bearblog/ 🎯. + +## Screenshots + +⬜️ [Light][light-screenshot] + +⬛️ [Dark][dark-screenshot] + +When 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. + +## Installation + +If you already have a Hugo site on your machine, you can simply add this theme via + +```bash +git submodule add https://github.com/janraasch/hugo-bearblog.git themes/hugo-bearblog +``` + +Then, adjust the `hugo.toml` as detailed below. + +For more information, read the official [setup guide][hugo-setup-guide] of Hugo. + +## Adjust configuration / hugo.toml + +Please 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. + +## Content & structure + +### Starting fresh + +If 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. + +### Adding / editing content + +#### Index-Page + +The contents of the `index`-page may be changed by editing your `content/_index.md`-file. + +#### Page + +You can add **a new page** via running + +```bash +hugo new my-new-page.md +``` + +#### Blog-Post + +You can add **a new blog-post** via running + +```bash +hugo new blog/my-new-post.md +``` + +### Adding your branding / colors / css + +Add 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. + +## Issues / Feedback / Contributing +Please use [GitHub issues](https://github.com/janraasch/hugo-bearblog/issues) and [Pull Requests](https://github.com/janraasch/hugo-bearblog/pulls). + +## Development +Run the `exampleSite` locally via + +```bash +hugo server --source ./exampleSite --themesDir ../.. +``` + +## Special Thanks 🎁 + +A special thank you goes out to [Herman](https://herman.bearblog.dev), for creating the original [ʕ•ᴥ•ʔ Bear Blog](https://bearblog.dev/). + +## License +[MIT License](http://en.wikipedia.org/wiki/MIT_License) © [Jan Raasch](https://www.janraasch.com) + +[hugo-setup-guide]: https://gohugo.io/getting-started/installing +[light-screenshot]: https://raw.githubusercontent.com/janraasch/hugo-bearblog/master/images/screenshot.png +[dark-screenshot]: https://raw.githubusercontent.com/janraasch/hugo-bearblog/master/images/screenshot-dark.png |