add readme

This commit is contained in:
askiiart 2025-04-19 18:58:12 -05:00
parent b566187396
commit c434f02745
Signed by untrusted user who does not match committer: askiiart
GPG key ID: 6A32977DAF31746A

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# My site
## Site generation
Pages are written as markdown files, then converted to HTML using `md2html.sh`, which converts them to pandoc and fixes some small bits (with `sed` and `regex-chicanery.py`). Then a new RSS feed and sitemap are generated using `generate-rss.sh` and `generate-sitemap.xml`.
## Organization
- Standard blog posts go in `/blog/`
- Today I learned stuff goes in `/til/`
- Misc data go in `/data/`
- Assets (images, videos, etc) go in `/assets/`, lining up with the organization of the page they go to (e.g. `/blog/marlin-boot-animations.{md,html}` -> `/assets/blog/marlin-boot-animations/`)
## Errors
Error pages are provided by [http-status-codes](https://git.askiiart.net/askiiart/http-status-codes).