This repository contains the source of "The Calyxium Programming Language" book.
We use mdBook to generate the book website.
You can install mdbook in one of the following ways:
-
Using Scoop (recommended for Windows)
If you're on Windows and have Scoop installed, run:scoop install mdbook
-
Manual installation
Follow the official installation guide for instructions.
To preview the book locally in your browser with live reload, run:
mdbook serve --openThis will start a local development server and automatically open the book in your default web browser.
Code blocks labeled with calyxium will be automatically tested to ensure they contain valid syntax.
These tests will run automatically when you run:
mdbook serve
You can also run the tests manually with:
python run_tests.py
If you want to exclude a code block from testing, simply add ,no to the end of the language tag.
We recommend using the Code Spell Checker extension for spell checking.
The words Calyxium and calyxup have already been added to the word list in cspell.json, so they won't be flagged as spelling errors and can be suggested as correct spellings.