updated repo readme file
Frank Homburg
3 years ago
parent
fec01bddc0
commit
da8a1e27ab
@ -1,91 +1,24 @@
|
|||||||
# Hugo ʕ•ᴥ•ʔ Bear Blog  [![Pay me][paypal-svg]][paypal-dot-me] [![Sponsor me][github-sponsors-svg]][github-sponsors]
|
<pre>
|
||||||
|
_____ .__
|
||||||
🧸 A [Hugo](https://gohugo.io/)-theme based on [Bear Blog](https://bearblog.dev).
|
_/ ____\ | |__ Frank Homburg
|
||||||
|
\ __\ | | \
|
||||||
> Free, no-nonsense, super-fast blogging.
|
| | | Y \ https://hmbrg.org
|
||||||
|
|__| |___| / https://git.sr.ht/~hmbrg
|
||||||
## Demo
|
\/
|
||||||
|
|
||||||
For a current & working demo of this theme, please check out https://janraasch.github.io/hugo-bearblog/ 🎯.
|
Script name: -
|
||||||
|
Description: Off-site backup of the no-JS club project website
|
||||||
## Screenshots
|
Dependencies: -
|
||||||
|
SourceHut: <a href="https://git.sr.ht/~hmbrg/no-js.club">website repo</a>
|
||||||
⬜️ [Light][light-screenshot]
|
License: -
|
||||||
|
Contributors: Frank Homburg
|
||||||
⬛️ [Dark][dark-screenshot]
|
Comments: This is a "just in case" copy of my of the no-JS.club website and also used to publish this site on sourcehut pages.
|
||||||
|
</pre>
|
||||||
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.
|
|
||||||
|
The [no-JS club](https://no-js.club) is a collection of websites that avoid the use of JavaScript and was inspired by projects like 250KB.club, 512KB.club, 1MB.club and the former noJS.club. If you want to join us please have a look at the FAQ to learn how.
|
||||||
## Sponsor 💟
|
|
||||||
|
If you are interested in joining the club, please first take a look at our [FAQ](https://no-js.club/faq/).
|
||||||
Support my work on this theme via [GitHub Sponsors][github-sponsors] (recurring) or [PayPal][paypal-dot-me] (one-time).
|
|
||||||
|
If you have read and understood the information there and accept the [Terms and Conditions](https://no-js.club/faq#your-website-has-to-be), please create a [Ticket](https://todo.sr.ht/~hmbrg/no-JS.club).
|
||||||
[][github-sponsors]
|
|
||||||
|
Once your request is accepted, your site will be listed on the [home page](https://no-js.club) of the project website.
|
||||||
## Installation
|
|
||||||
|
|
||||||
If you already have a Hugo site on your machine, you can simply add this theme via
|
|
||||||
|
|
||||||
```
|
|
||||||
git submodule add https://github.com/janraasch/hugo-bearblog.git themes/hugo-bearblog
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, adjust the `config.toml` as detailed below.
|
|
||||||
|
|
||||||
For more information, read the official [setup guide][hugo-setup-guide] of Hugo.
|
|
||||||
|
|
||||||
## Adjust configuration / config.toml
|
|
||||||
|
|
||||||
Please check out the [config.toml](https://github.com/janraasch/hugo-bearblog/blob/master/exampleSite/config.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
|
|
||||||
|
|
||||||
```
|
|
||||||
hugo new my-new-page.md
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Blog-Post
|
|
||||||
|
|
||||||
You can add **a new blog-post** via running
|
|
||||||
|
|
||||||
```
|
|
||||||
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).
|
|
||||||
|
|
||||||
If you do not have a GitHub-account, please hit me up via e-mail (see [janraasch.com](https://www.janraasch.com)).
|
|
||||||
|
|
||||||
## 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)
|
|
||||||
|
|
||||||
[paypal-dot-me]: https://www.paypal.me/janraasch/7,00
|
|
||||||
[github-sponsors]: https://github.com/sponsors/janraasch
|
|
||||||
[paypal-svg]: https://img.shields.io/badge/onetime-donation-11dde2.svg?logo=paypal
|
|
||||||
[github-sponsors-svg]: https://img.shields.io/badge/recurring-sponsorship-ee4aaa.svg?logo=github
|
|
||||||
[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
|
|
||||||
|
|||||||
Loading…
Reference in New Issue