README.md — sigil-site

1# sigil-site

3Source for [usesigil.org](https://usesigil.org), built with [Press](https://codeberg.org/sigil/press).

5## Prerequisites

You need a working [Sigil](https://codeberg.org/sigil/sigil) installation (0.9.1+). The Sigil monorepo must be cloned alongside this one for documentation source:

9```

10sigil/ # Sigil monorepo (docs, releases, API source)

11sigil-site/ # This repo

12```

14API documentation requires a built copy of Sigil's dev libraries:

16```bash

17cd ../sigil && sigil build && cd -

18```

20## Building

22```bash

23sigil deps install # Install dependencies (first time / after changes)

24./build.sh build # Build the site to public/

25./build.sh serve # Dev server with live reload

26```

28## Project structure

30```

31sigil-site/

32 src/sigil-site/main.sgl # Site pipeline configuration

33 site/ # SXML page templates (landing page, etc.)

34 assets/repl/ # Interactive playground (TODO)

35 package.sgl # Package definition and dependencies

36 build.sh # Build orchestration script

37 dev-redirects.sgl # Dependency redirects for local development

38```

40## Content sources

42All documentation lives in the sigil monorepo and is pulled in at build time:

44- `../sigil/docs/` -- Markdown documentation, published under `/docs/`

45- `../sigil/RELEASES.md` -- Release changelog

46- `../sigil/build/dev/lib/` -- Compiled libraries for API doc generation, published under `/docs/lib/`

48Page templates in `site/` are written in SXML (S-expression HTML).

50## Playground

The interactive playground (Try It) is not yet integrated into this repo. It is built from the sigil-playground package in the sigil monorepo. The `assets/repl/` directory is a placeholder.