summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorPaweł Redman <pawel.redman@gmail.com>2026-06-14 18:36:53 +0200
committerPaweł Redman <pawel.redman@gmail.com>2026-06-14 18:36:53 +0200
commit444d3196359be6bb82fdb6a0f5d5ba32fde4118a (patch)
treeee7e5942b44a37438a366b580558955042df79bc /AGENTS.md
Initial commit
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..382bf14
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,33 @@
+# redman.xyz — 2026 modernization
+
+redman.xyz is my personal website and a technical blog. Currently it runs on DokuWiki. I've downloaded all text to `old_pages/` and embedded images to `old_media/`.
+
+The goal of this project is switching over to Typst using their experimental HTML output mode. `blog-torture/` contains a reference document that renders correctly, including equations.
+
+## Repo structure
+
+`blog-torture/`, `old_pages/`, `old_media/` – temp files to be removed after migration
+
+`site/` — source .typ files
+`static/` — CSS, images, etc.
+`public/` — ready-to-publish site goes here
+
+## Migration
+
+Keep text verbatim. If there are any typos or other errors, point them out in the chat and keep them.
+
+`=` corresponds to `<h2>`. It's a level below the title, so use it for sections.
+
+For internal links, use `#link-self(page)[...])` from `common.typ`. The argument is a path relative to `site/content/` without the file extension.
+
+`static(path)` returns the URL to a file in `static/`. Path is relative to that directory.
+
+Replace links to scientific articles with references to the bibliography (`refs.bib`).
+
+Use `img(url)` from `common.typ` for `<img>`.
+
+## Building
+
+```
+uv run build.py
+```