sigil-site

Source for usesigil.org, built with Press.

Prerequisites

You need a working Sigil installation (0.9.1+). The Sigil monorepo must be cloned alongside this one for documentation source:

sigil/         # Sigil monorepo (docs, releases, API source)
sigil-site/    # This repo

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

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

Building

sigil deps install   # Install dependencies (first time / after changes)
./build.sh build     # Build the site to public/
./build.sh serve     # Dev server with live reload

Project structure

sigil-site/
  src/sigil-site/main.sgl   # Site pipeline configuration
  site/                      # SXML page templates (landing page, etc.)
  assets/repl/               # Interactive playground (TODO)
  package.sgl                # Package definition and dependencies
  build.sh                   # Build orchestration script
  dev-redirects.sgl          # Dependency redirects for local development

Content sources

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

• ../sigil/docs/ -- Markdown documentation, published under /docs/
• ../sigil/RELEASES.md -- Release changelog
• ../sigil/build/dev/lib/ -- Compiled libraries for API doc generation, published under /docs/lib/

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

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.