From 0d6bec6451f65038e16d514ac36f7ec208190856 Mon Sep 17 00:00:00 2001
From: Oliver Ladner <waste@lugh.ch>
Date: Fri, 13 Dec 2024 14:59:35 +0100
Subject: [PATCH] docs: update development parts of README

---
 pelican/themes/simple/README.md | 39 +++++++++++++++++++++++----------
 1 file changed, 28 insertions(+), 11 deletions(-)

diff --git a/pelican/themes/simple/README.md b/pelican/themes/simple/README.md
index 22151300..f3fe9563 100644
--- a/pelican/themes/simple/README.md
+++ b/pelican/themes/simple/README.md
@@ -1,26 +1,43 @@
 # lugh Pelican theme
 
-Heavy work in progress
+This theme is based on the [simple theme](https://github.com/getpelican/pelican/tree/main/pelican/themes/simple/templates).
+It's heavily customized to what I need here, so no efforts have been made to
+keep it useful for others. Amongst other things, I:
+
+- removed translations
+- changed the structure (HTML `<footer>` etc.)
 
 ## Docs
 
-### Pelican: how to create your own theme
+- [Pelican: how to create your own theme](https://docs.getpelican.com/en/stable/themes.html)
+- [Tailwind CSS quick start](https://tailwindcss.com/docs/installation)
 
-https://docs.getpelican.com/en/stable/themes.html
+## Doing
 
-### Tailwind CSS quick start
+### Prepare Pelican development server config
 
-https://tailwindcss.com/docs/installation
+Adapt Pelican's `publishconf.py` for local development.
+E.g. `RELATIVE_URLS = False`
 
-### Tailwind CSS Typography plugin
+### Install Tailwind CSS Typography plugin
+
+Typography enables sane defaults for longer texts. In this case, we use it for
+the body content only, which is always Markdown. Typography is a bit of a beast
+to configure/align to standard Tailwind.
 
 ```shell
 npm install -D @tailwindcss/typography
 ```
 
-## My requirements for this theme
+### Run the Tailwind build process
 
--   WCAG 2.2 :construction:
--   Light and dark mode :construction:
--   Code highlighting :construction:
--   Markdown prettification
+```shell
+npx tailwindcss -i static/css/in.css -o static/css/out.css --watch
+```
+
+### Run Pelican dev server
+
+```shell
+conda activate pelican
+./devserver.sh
+```