From 87322aba527be085fd05e4ae26cb3e1b7139d5f0 Mon Sep 17 00:00:00 2001 From: Alan Pearce Date: Mon, 17 Apr 2023 20:15:39 +0200 Subject: Add readme and license --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..8caaef0 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Zola ʕ•ᴥ•ʔ Bear Blog + +🧸 A [Zola](https://www.getzola.org/)-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://alanpearce.codeberg.page/zola-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://codeberg.org/alanpearce/zola-bearblog/src/branch/main/templates/style.html)-file for the implementation. + +## Installation + +If you already have a Zola site on your machine, you can simply add this theme via + +``` +git submodule add https://codeberg.org/alanpearce/zola-bearblog themes/zola-bearblog +``` + +Then, adjust the `config.toml` as detailed below. + +For more information, read the official [setup guide][zola-setup-guide] of Zola. + +## Adjust configuration / config.toml + +Please check out the included [config.toml](https://codeberg.org/alanpearce/zola-bearblog/src/branch/main/config.toml) + +## Content & structure + +### Adding / editing content + +#### Index-Page + +The contents of the `index`-page may be changed by editing your `content/_index.md`-file. + + +### Adding your branding / colors / css + +Add a `custom_head.html`-file to your `templates/`-directory. In there you may add a `