From 72eec2299707881e9e58660467e37b777b51a632 Mon Sep 17 00:00:00 2001 From: Alan Pearce Date: Mon, 17 Apr 2023 19:59:34 +0200 Subject: Initial commit --- .envrc | 1 + config.toml | 33 ++++++++ content/_index.md | 23 ++++++ content/bear.md | 17 ++++ content/blog/_index.md | 3 + content/blog/markdown-syntax.md | 130 ++++++++++++++++++++++++++++++ content/zola.md | 36 +++++++++ flake.lock | 61 ++++++++++++++ flake.nix | 20 +++++ templates/404.html | 8 ++ templates/base.html | 39 +++++++++ templates/favicon.html | 3 + templates/footer.html | 3 + templates/header.html | 4 + templates/index.html | 7 ++ templates/nav.html | 6 ++ templates/page.html | 33 ++++++++ templates/section.html | 38 +++++++++ templates/seo_tags.html | 1 + templates/style.html | 173 ++++++++++++++++++++++++++++++++++++++++ templates/taxonomy_list.html | 14 ++++ templates/taxonomy_single.html | 30 +++++++ theme.toml | 23 ++++++ 23 files changed, 706 insertions(+) create mode 100644 .envrc create mode 100644 config.toml create mode 100644 content/_index.md create mode 100644 content/bear.md create mode 100644 content/blog/_index.md create mode 100644 content/blog/markdown-syntax.md create mode 100644 content/zola.md create mode 100644 flake.lock create mode 100644 flake.nix create mode 100644 templates/404.html create mode 100644 templates/base.html create mode 100644 templates/favicon.html create mode 100644 templates/footer.html create mode 100644 templates/header.html create mode 100644 templates/index.html create mode 100644 templates/nav.html create mode 100644 templates/page.html create mode 100644 templates/section.html create mode 100644 templates/seo_tags.html create mode 100644 templates/style.html create mode 100644 templates/taxonomy_list.html create mode 100644 templates/taxonomy_single.html create mode 100644 theme.toml diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..3550a30 --- /dev/null +++ b/.envrc @@ -0,0 +1 @@ +use flake diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..a834b0b --- /dev/null +++ b/config.toml @@ -0,0 +1,33 @@ +title = "Zola ʕ•ᴥ•ʔ Bear Blog" +base_url = "https://codeberg.org/alanpearce/zola-bearblog" +description = "" + +# Whether to automatically compile all Sass files in the sass directory +compile_sass = false + +# Whether to build a search index to be used later on by a JavaScript library +build_search_index = false + +taxonomies = [ + {name = "categories", feed = true}, + {name = "tags", feed = true}, +] + +[markdown] +# Whether to do syntax highlighting +# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola +highlight_code = true + +[extra] + +[[extra.main_menu]] +name = "Bear" +url = "@/bear.md" + +[[extra.main_menu]] +name = "Zola" +url = "@/zola.md" + +[[extra.main_menu]] +name = "Blog" +url = "@/blog/_index.md" diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..7392780 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,23 @@ ++++ ++++ +# A match made in heaven + +There is a website obesity crisis. Bloated websites full of scripts, ads, and trackers are slowing your readers down every time they try to read your well-crafted content. + +Hugo Bear Blog is all you need to build a fantastic and optimized site or blog. It works perfectly on **any** viewing device. All you need to focus on is writing good content. + +[Go to the original bear blog](https://bearblog.dev/). + +--- + +What happens when you combine the worlds' fastest, most lightweight static site generator with a design theme built to provide you with free, no-nonsense, super-fast blogging capabilities? + +**Use this theme, and find out!** + +Made with 💚 by [Alan Pearce](https://alanpearce.eu). + +--- + +Simply publish content online, grow an audience, and keep your pages tiny, fast, and **optimized for search engines**. + +Each page is ~5kb, and you can **host your blog yourself**. diff --git a/content/bear.md b/content/bear.md new file mode 100644 index 0000000..62f5db5 --- /dev/null +++ b/content/bear.md @@ -0,0 +1,17 @@ ++++ +title = "Bear" ++++ + +# Bear + +Website: [https://bearblog.dev](https://bearblog.dev) + +There is a website obesity crisis. Bloated websites are full of scripts, ads, and trackers slowing your readers down every time they try to read your well-crafted content. + +Bear is all you need to build a fantastic and optimized site or blog. It works perfectly on **any** viewing device. All you need to focus on is writing good content. + +Bear makes it simple to publish content online and grow an audience while keeping pages tiny, fast, and **optimized for search engines.** + +Each page is ~5kb. + +Learn more and contribute on [GitHub](https://github.com/HermanMartinus/bearblog). diff --git a/content/blog/_index.md b/content/blog/_index.md new file mode 100644 index 0000000..34651ab --- /dev/null +++ b/content/blog/_index.md @@ -0,0 +1,3 @@ ++++ +title = "Blog" ++++ diff --git a/content/blog/markdown-syntax.md b/content/blog/markdown-syntax.md new file mode 100644 index 0000000..509cb4a --- /dev/null +++ b/content/blog/markdown-syntax.md @@ -0,0 +1,130 @@ ++++ +title = "Markdown Syntax Guide" +date = "2020-01-03" +description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements." +taxonomies.tags = [ + "markdown", + "syntax", +] ++++ + +For a quick cheatsheet, check out [https://simplemde.com/markdown-guide](https://simplemde.com/markdown-guide). + +--- + +This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme. + + +## Headings + +The following HTML `

`—`

` elements represent six levels of section headings. `

` is the highest section level while `

` is the lowest. + +# H1 +## H2 +### H3 +#### H4 +##### H5 +###### H6 + +## Paragraph + +Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat. + +Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. + +## Blockquotes + +The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations. + +#### Blockquote without attribution + +> Tiam, ad mint andaepu dandae nostion secatur sequo quae. +> **Note** that you can use *Markdown syntax* within a blockquote. + +#### Blockquote with attribution + +> Don't communicate by sharing memory, share memory by communicating.
+> — Rob Pike[^1] + +[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015. + +## Tables + +Tables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box. + + Name | Age +--------|------ + Bob | 27 + Alice | 23 + +#### Inline Markdown within tables + +| Italics | Bold | Code | +| -------- | -------- | ------ | +| *italics* | **bold** | `code` | + +## Code Blocks + +#### Code block with backticks + +```html + + + + + Example HTML5 Document + + +

Test

+ + +``` + +#### Code block indented with four spaces + + + + + + Example HTML5 Document + + +

Test

+ + + +## List Types + +#### Ordered List + +1. First item +2. Second item +3. Third item + +#### Unordered List + +* List item +* Another item +* And another item + +#### Nested list + +* Fruit + * Apple + * Orange + * Banana +* Dairy + * Milk + * Cheese + +## Other Elements — abbr, sub, sup, kbd, mark + +GIF is a bitmap image format. + +H2O + +Xn + Yn = Zn + +Press CTRL+ALT+Delete to end the session. + +Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures. diff --git a/content/zola.md b/content/zola.md new file mode 100644 index 0000000..5458750 --- /dev/null +++ b/content/zola.md @@ -0,0 +1,36 @@ ++++ +title = "Zola" ++++ +## No dependencies + +Zola comes as a single executable with Sass compilation, syntax +highlighting, table of contents and many other features that +traditionally require setting up a dev environment or adding some +JavaScript libraries to your site. + +## Blazing fast + +The average site will be generated in less than a second, including +Sass compilation and syntax highlighting. + +## Scalable + +Zola renders your whole site as static files, making it trivial to +handle any kind of traffic you will throw at it at no cost without +having to worry about managing a server or a database. + +## Easy to use + +From the CLI to the template engine, everything is designed to be +intuitive. Don't take my word for it though, look at the documentation +and see for yourself. + +## Flexible + +Zola gets out of your way so you can focus on your content, be it a +blog, a knowledge base, a landing page or a combination of them. + +## Augmented Markdown + +Zola comes with shortcodes and internal links to make it easier to +write your content. diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..afbf271 --- /dev/null +++ b/flake.lock @@ -0,0 +1,61 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1681202837, + "narHash": "sha256-H+Rh19JDwRtpVPAWp64F+rlEtxUWBAQW28eAi3SRSzg=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "cfacdce06f30d2b68473a46042957675eebb3401", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1681693905, + "narHash": "sha256-XdXMvCt+i2ZcmAIPZvu3RUwcdaC9OX7d1WMAJJokzeA=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "db34d7561caa508ece0265a56f382c5d3b7a6c1b", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixpkgs-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..c257b2a --- /dev/null +++ b/flake.nix @@ -0,0 +1,20 @@ +{ + description = "A bear blog theme for Zola"; + inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; + inputs.flake-utils.url = "github:numtide/flake-utils"; + + outputs = { self, nixpkgs, flake-utils }: + flake-utils.lib.eachDefaultSystem (system: + let + pkgs = nixpkgs.legacyPackages.${system}; + in + { + devShells.default = pkgs.mkShell { + packages = with pkgs; [ + git + gnugrep + zola + ]; + }; + }); +} diff --git a/templates/404.html b/templates/404.html new file mode 100644 index 0000000..bfb6e35 --- /dev/null +++ b/templates/404.html @@ -0,0 +1,8 @@ +{% extends "base.html" %} + +{% block title %}404{% endblock %} + +{% block main %} +

404

+

ʕノ•ᴥ•ʔノ ︵ ┻━┻

+{% endblock %} diff --git a/templates/base.html b/templates/base.html new file mode 100644 index 0000000..299e92a --- /dev/null +++ b/templates/base.html @@ -0,0 +1,39 @@ + + + + + + + + {%- include "favicon.html" ignore missing -%} + {%- block title %}{{ config.title }}{%- endblock %} + + {%- include "seo_tags.html" ignore missing -%} + + + {%- if config.generate_feed %} + {%- block rss -%} + + {% endblock -%} + {%- endif %} + + {%- include "style.html" ignore missing -%} + + {%- include "custom_head.html" ignore missing -%} + + + +
+ {%- include "header.html" ignore missing -%} +
+
+ {%- block main %}{%- endblock %} +
+ + + {%- include "custom_body.html" ignore missing -%} + + + diff --git a/templates/favicon.html b/templates/favicon.html new file mode 100644 index 0000000..51d9fbd --- /dev/null +++ b/templates/favicon.html @@ -0,0 +1,3 @@ +{% if config.extra.favicon %} + +{%- endif %} diff --git a/templates/footer.html b/templates/footer.html new file mode 100644 index 0000000..97d6b89 --- /dev/null +++ b/templates/footer.html @@ -0,0 +1,3 @@ +{% if not config.extra.hide_made_with_line %} +Made with Zola ʕ•ᴥ•ʔ Bear +{% endif %} diff --git a/templates/header.html b/templates/header.html new file mode 100644 index 0000000..64c79f0 --- /dev/null +++ b/templates/header.html @@ -0,0 +1,4 @@ + +

{{ config.title }}

+ + diff --git a/templates/index.html b/templates/index.html new file mode 100644 index 0000000..31710be --- /dev/null +++ b/templates/index.html @@ -0,0 +1,7 @@ +{% extends "base.html" %} + +{% block main %} + + {{ section.content | safe }} + +{% endblock %} diff --git a/templates/nav.html b/templates/nav.html new file mode 100644 index 0000000..135e407 --- /dev/null +++ b/templates/nav.html @@ -0,0 +1,6 @@ +Home +{%- if config.extra.main_menu %} +{%- for item in config.extra.main_menu %} +{{ item.name }} +{%- endfor %} +{%- endif %} diff --git a/templates/page.html b/templates/page.html new file mode 100644 index 0000000..bf9eca7 --- /dev/null +++ b/templates/page.html @@ -0,0 +1,33 @@ +{% extends "base.html" %} + +{% block title %} +{{ page.title }} | {{ super() }} +{% endblock %} + +{% block main %} +{%- if not page.extra.menu %} +

{{ page.title }}

+{%- if page.date %} +

+ + + +

+{%- endif %} +{%- endif %} + + {{ page.content | safe }} + +

+ {%- if page.taxonomies %} + {%- for name, taxon in page.taxonomies %} + {{ name | capitalize }}: + {%- for item in taxon %} + #{{ item }} + {%- endfor %} + {%- endfor %} + {%- endif %} +

+{% endblock %} diff --git a/templates/section.html b/templates/section.html new file mode 100644 index 0000000..6801267 --- /dev/null +++ b/templates/section.html @@ -0,0 +1,38 @@ +{% extends "base.html" %} + +{% block main %} + + {%- if taxonomy.term %} +

Filtering for "{{ section.title }}"

+ + Remove filter + + {%- endif %} + + +
+ {% set tags = get_taxonomy(kind="tags") %} + {% for post in tags.items %} + #{{ post.name }}  + {% endfor %} +
+ + +{% endblock %} diff --git a/templates/seo_tags.html b/templates/seo_tags.html new file mode 100644 index 0000000..88c14e0 --- /dev/null +++ b/templates/seo_tags.html @@ -0,0 +1 @@ + diff --git a/templates/style.html b/templates/style.html new file mode 100644 index 0000000..122a641 --- /dev/null +++ b/templates/style.html @@ -0,0 +1,173 @@ + diff --git a/templates/taxonomy_list.html b/templates/taxonomy_list.html new file mode 100644 index 0000000..876087c --- /dev/null +++ b/templates/taxonomy_list.html @@ -0,0 +1,14 @@ +{% extends "base.html" %} + +{% block main %} + + +
+ {% set tags = get_taxonomy(kind="tags") %} + {% for post in tags.items %} + #{{ post.name }}  + {% endfor %} +
+ + +{% endblock %} diff --git a/templates/taxonomy_single.html b/templates/taxonomy_single.html new file mode 100644 index 0000000..685eaf5 --- /dev/null +++ b/templates/taxonomy_single.html @@ -0,0 +1,30 @@ +{% extends "base.html" %} + +{% block main %} + + {%- if taxonomy.term %} +

Filtering for "{{ term.name }}"

+ + Remove filter + + {%- endif %} + + +{% endblock %} diff --git a/theme.toml b/theme.toml new file mode 100644 index 0000000..77d333d --- /dev/null +++ b/theme.toml @@ -0,0 +1,23 @@ +name = "Bear" +description = "Bear blog theme" +license = "MIT" +homepage = "https://github.com/getzola/hyde" +# The minimum version of Zola required +min_version = "0.4.0" +# An optional live demo URL +demo = "" + +# Any variable there can be overridden in the end user `config.toml` +# You don't need to prefix variables by the theme name but as this will +# be merged with user data, some kind of prefix or nesting is preferable +# Use snake_casing to be consistent with the rest of Zola +[extra] + +[author] +name = "Alan Pearce" +homepage = "https://alanpearce.eu" + +[original] +author = "janraasch" +repo = "https://github.com/janraasch/hugo-bearblog/" +homepage = "https://www.janraasch.com" -- cgit 1.4.1 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 --- LICENSE | 21 +++++++++++++++++++++ README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 81 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ddc924b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2023 Alan Pearce +Copyright (c) 2020 Jan Raasch + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 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 `