mirror of
https://github.com/prdlk/website.git
synced 2026-08-03 09:51:41 +00:00
docs(ui): add AGENTS.md files for component documentation
This commit is contained in:
@@ -0,0 +1,31 @@
|
||||
<!-- Parent: ../AGENTS.md -->
|
||||
<!-- Generated: 2026-06-30 | Updated: 2026-06-30 -->
|
||||
|
||||
# styles
|
||||
|
||||
## Purpose
|
||||
Global CSS and component/block styles. Tailwind v4 is configured via CSS (`global.css`) rather than a large JS config.
|
||||
|
||||
## Key Files
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `global.css` | Tailwind import + theme: color tokens (`--color-global-bg`, `--color-global-text`, `--color-accent`, `--color-link`, `--color-muted`, `--color-special-*`), dark/light variants, base element styles, and the `cactus-link` / `title` utility classes. |
|
||||
|
||||
## Subdirectories
|
||||
| Directory | Purpose |
|
||||
|-----------|---------|
|
||||
| `blocks/` | `search.css` — Pagefind search UI styling. |
|
||||
| `components/` | `admonition.css` and `github-card.css` — styles for the matching remark plugins. |
|
||||
|
||||
## For AI Agents
|
||||
|
||||
### Working In This Directory
|
||||
- Use the defined color tokens (e.g. `text-muted`, `bg-global-bg`, `border-global-text/15`) for theme consistency rather than hardcoded colors — they adapt to dark/light mode.
|
||||
- New markdown block plugins (in `src/plugins/`) should get their CSS here under `components/`.
|
||||
|
||||
## Dependencies
|
||||
|
||||
### External
|
||||
- `tailwindcss` v4, `@tailwindcss/typography` (prose), `cssnano`, `autoprefixer`.
|
||||
|
||||
<!-- MANUAL: -->
|
||||
Reference in New Issue
Block a user