Documentation for the Spade hardware description language
- Typst 71.7%
- Rust 15.3%
- JavaScript 6.2%
- Python 3.7%
- CSS 1.9%
- Other 1.2%
| .forgejo/workflows | ||
| spade-lang.org@dea46ca6f2 | ||
| src | ||
| swim@d68bed8475 | ||
| typst | ||
| typst-lib | ||
| .gitignore | ||
| .gitmodules | ||
| _typos.toml | ||
| book.toml | ||
| build_content.sh | ||
| generate_swim_docs | ||
| README.md | ||
docs.spade-lang.org
The docs use mdbook as the primary generator, with content currently being a mix of markdown
and typst. We are trying to migrate to typst so new doc pages should preferably be created with it.
All typst sources are in typst/ and get compiled into src/typst. Non-typst sources inside typst get mirrored into the same directory to make relative paths work as expected.
The typst part currently depends on the main website theme which is included as a submodule.
git submodule update --init --recursive
For development, run
mdbook serve
and
watchexec -e typ -e spade ./build_content.sh