# CStar Docs

**Repository Path**: cstarlang/cstar_docs

## Basic Information

- **Project Name**: CStar Docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2026-07-12
- **Last Updated**: 2026-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# C* Docs

Source for the official C\* website at **https://cstarlang.org**: a static
tutorial + reference site in the spirit of the
[Verus guide](https://verus-lang.github.io/verus/guide/).

The site is authored in **Typst** (not Markdown) and built with
[**shiroa**](https://github.com/Myriad-Dreamin/shiroa) — "mdBook, but in pure
Typst." It is **bilingual**: English under `/en/` and 中文 under `/zh/`, with
`cstarlang.org/` redirecting to the Chinese site.

## Layout

```
cstar_docs/
├── en/                     # English book (its own typst root-relative tree)
│   ├── book.typ            # metadata + table of contents (mdBook's book.toml + summary.md)
│   ├── templates/page.typ  # page/theme template (Starlight for static-html, mdBook for dyn-paged)
│   ├── intro.typ           # landing page
│   ├── tutorial/…          # tutorial chapters
│   └── reference/…         # reference chapters
├── zh/                     # 中文 book (mirror of en/)
├── shared/
│   ├── components.typ      # semantic vocabulary: defn/thm/proof/exercise/aside/wall/dialogue/…
│   └── lang-switch.typ     # "EN | 中文" switcher
├── assets/imgs/            # images
├── scripts/
│   ├── dev.sh              # full-site local preview (both books, switcher works)
│   └── deploy.sh           # build + rsync to the web server
└── dist/                   # build output (git-ignored)
```

Each language is its own Typst *root-relative* tree because shiroa's page
template does `include "/<lang>/book.typ"`, and Typst `include` needs a literal
path. Builds run with `--root .` (the repo root), so both books can share
`/shared/`.

## Development

Preview, build, deploy, and content-authoring instructions live in
**[DEVELOPING.md](DEVELOPING.md)**. In short:

```sh
scripts/dev.sh       # local preview of the full site at http://localhost:8787
scripts/deploy.sh    # build both languages into ./dist
PUBLISH=1 DEPLOY_TARGET=user@host:/srv/www/cstarlang/ scripts/deploy.sh   # build + rsync to the server
```