From 76b00b6fdde212d93864e87de2c3759c28844ee5 Mon Sep 17 00:00:00 2001
From: foswret <foswret@posteo.com>
Date: Sat, 4 Apr 2026 16:05:07 -0500
Subject: track README.md

---
 README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..55b8b8d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# Shawl
+- A simple, unintrusive theme for Zola.
+
+## Goals
+- Minimal CSS
+- Appealing design
+- Readable code
+- Dry templating
+
+## Dependencies
+- `zola`
+
+## Install
+If you haven't already, initialize a website. Say "No" to enabling Sass compilation, enabling syntax highlighting, and building a search index of content. Shawl does not take advantage of any of these features.
+
+```shell
+zola init website # Create website
+```
+
+Clone this repo into the `themes` directory. 
+
+```shell
+cd themes
+git clone https://git.foswret.com/shawl
+```
+
+Edit the `zola.toml` file in the root directory to something like this. Everything should be pretty standard, except the inclusion of `[extra]` and `navbar_items`. This theme requires all items in the navigation bar to be specified manually. In this example, the "Posts" section is added, but of this of course can be any section you wish.
+
+```toml
+base_url = "https://mysite.com"
+
+# Site title and description
+title = "my site"
+description = ""
+default_language = "en"
+
+theme = "shawl"
+
+[extra]
+navbar_items = [
+{ name = "Home", url = "/", divider = " | " },
+{ name = "Posts", url = "/posts" },
+]
+```
+
+## Config
+- To generate an `atom.xml` file, and enable smart punctuation:
+```toml
+# Generate RSS feed
+generate_feeds = true
+
+[markdown]
+# Change quotes into curly quotes
+smart_punctuation = true
+```
+- the stylesheet is located in `static/style.css`. 
+    - The header color can be changed by changing the value of the `--primary-header-color` variable.
+    - Change the accent background by changing the location of your background image, as defined in the `#right-header` ID. 
+- In your website's root directory, create a file `footer.html` in a `templates/paritals` directory. This way, you can customize your footer however you like.
-- 
cgit v1.2.3