From da8a1e27ab4f854cc10f8103fdbe1a7db0f74c6b Mon Sep 17 00:00:00 2001 From: Frank Homburg Date: Fri, 29 Apr 2022 16:49:47 +0200 Subject: [PATCH] updated repo readme file --- README.md | 115 ++++++++++++------------------------------------------ 1 file changed, 24 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 0fed476..4ff9158 100644 --- a/README.md +++ b/README.md @@ -1,91 +1,24 @@ -# Hugo ʕ•ᴥ•ʔ Bear Blog ![Test](https://github.com/janraasch/hugo-bearblog/workflows/CI/badge.svg?branch=master&event=push) [![Pay me][paypal-svg]][paypal-dot-me] [![Sponsor me][github-sponsors-svg]][github-sponsors] - -🧸 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. - -## Sponsor 💟 - -Support my work on this theme via [GitHub Sponsors][github-sponsors] (recurring) or [PayPal][paypal-dot-me] (one-time). - -[![GitHub Stats](https://github-readme-stats.vercel.app/api/?username=janraasch)][github-sponsors] - -## 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 `