Commita85c2a61Recorded29 Mar 2026Repositorysigil-web-styles
Add comprehensive README
Changed
README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 59 insertions(+), 1 deletion(-)Diff
README.mdmodified
@@ -1,3 +1,61 @@
1
# sigil-web-styles 2
−3
Design system and theme library for Sigil web applications 3
No newline at end of file+4
Design system and theme library for [Sigil](https://codeberg.org/sigil/sigil) web applications. Provides palettes, typography, component styles, and layouts for a consistent look across Sigil apps with customizable color themes.+5
+6
Built on top of [sigil-css](https://codeberg.org/sigil/sigil-css).+7
+8
## Usage+9
+10
```scheme+11
(import (sigil web styles))+12
+13
;; Get the full stylesheet with the default black+gold theme+14
(theme-stylesheet)+15
+16
;; Or customize the palette+17
(theme-stylesheet palette: (make-palette+18
background: "#0a0a1a"+19
primary: "#4a90d9"+20
...))+21
```+22
+23
## Default Theme+24
+25
Black and gold with subtle gradients:+26
- Background: `#0d0d0d` (near-black)+27
- Surface: `#1a1a1a` (cards, panels) with subtle top-to-bottom gradient+28
- Accent: `#d4a017` (gold) with gradient shine on buttons+29
- Text: `#e8e8e8` (off-white)+30
+31
## Modules+32
+33
| Module | Purpose |+34
|--------|---------|+35
| `(sigil web styles)` | Main entry — re-exports everything |+36
| `(sigil web styles palette)` | Color palettes and customization |+37
| `(sigil web styles typography)` | Font stacks, type scale, weights |+38
| `(sigil web styles components)` | Cards, tables, badges, buttons, nav, inputs |+39
| `(sigil web styles layout)` | Page shell, grid system, responsive breakpoints |+40
+41
## Apps Using This Theme+42
+43
- [Vigil](https://codeberg.org/sigil/vigil) — service monitoring dashboard+44
- [Kiln](https://codeberg.org/sigil/kiln) — CI server+45
- [Folio](https://codeberg.org/sigil/folio) — task and knowledge management+46
- [Live Crafter](https://codeberg.org/SystemCrafters/live-crafter) — stream management+47
+48
## Dependencies+49
+50
- sigil-css+51
- sigil-stdlib+52
+53
## Build+54
+55
```sh+56
sigil build sigil-web-styles+57
sigil test+58
```+59
+60
## License+61
+62
BSD-3-Clause