add README

This commit is contained in:
Yan Lin 2026-02-06 13:28:04 +01:00
parent d8ea74211f
commit e1e500733e
2 changed files with 52 additions and 1 deletions

51
README.md Normal file
View file

@ -0,0 +1,51 @@
## Project Structure
- `config.toml`: site config (base_url, title, markdown settings)
- `content/`: blog posts organized by category (ml-tech, homelab, ai-system, dl4traj)
- `templates/`: Zola templates + shortcodes
- `sass/style.scss`: styles with light/dark mode via CSS variables
- `static/`: favicons, web manifest
- `public/`: built output
## Shortcodes
Image with max-width constraint. `width` defaults to `500px`:
```md
{% img(src="./diagram.png", alt="Architecture", width="600px") %}
```
Figure caption:
```md
{% cap() %}The *architecture* diagram{% end %}
```
Block math:
```md
{% math() %}
\nabla \cdot \mathbf{E} = \frac{\rho}{\epsilon_0}
{% end %}
```
Inline math:
```md
The loss {% m() %}\mathcal{L}{% end %} is minimized.
```
Inserts table of contents where placed:
```md
{{ toc() }}
```
## Cloudflare Pages Deployment
To use a specific version of Zola, and to handle Cloudflare's distinction between preview and production builds:
```bash
curl -sL https://github.com/getzola/zola/releases/download/v0.22.1/zola-v0.22.1-x86_64-unknown-linux-gnu.tar.gz | tar xz && if [ "$CF_PAGES_BRANCH" = "main" ]; then ./zola build; else ./zola build --base-url $CF_PAGES_URL; fi
```