This repository is the home for general user documentation for everything to do with twinBASIC.

If you would like to quickly contribute, feel free to:

• submit a Pull Request,

• or create a new page on the Wiki for new topics, or for additions to the documentation.

If you want to get involved in improving this documentation directly, please fork this repository (https://github.com/twinbasic/documentation.git), and submit pull requests for your suggested changes.

All help is very much appreciated :)

The site is rendered by tbdocs, a Node.js static site generator kept in builder/. You need Node.js 22+; a PDF or accessibility run additionally needs Chromium, installed once with npx puppeteer browsers install chrome (add --install-deps on Linux only).

npm ci          # once, from the repository root
build.bat       # renders _site/, _site-offline/ and _site-pdf/, and link-checks them
serve.bat       # localhost:4000 with watch + live reload
check.bat       # the gates that read the built site, ending in the accessibility scan
test.bat        # the gates that test the toolchain itself
book.bat        # renders the PDF book; run build.bat first
examples.bat    # compiles the twinBASIC code samples in the pages (Windows + a twinBASIC install)
addin-test.bat  # tests IDE add-ins by operating an IDE (Windows + a twinBASIC install)
ide-test.bat    # tests the IDE itself by operating it (Windows + a twinBASIC install)
try-help-addin.bat  # opens an IDE with the help add-in, to try it by hand (Windows + a twinBASIC install)

A clean build.bat && check.bat is the bar for "ready to commit"; add test.bat when the change touched anything outside docs/. Each wrapper names the gates it runs, in order, on Tools and Scripts. On Linux or macOS, run the node command inside each batch file directly --- they are thin wrappers. examples.bat, addin-test.bat and ide-test.bat are the exceptions to both: they drive the twinBASIC IDE, so they are Windows-only and deliberately outside every gate and outside CI.

Where to read more:

• Writing or editing a page --- Authoring Pages covers frontmatter, headings, prose style, attribution and links.
• The build and deployment workflow --- Building and Deployment.
• Every command and flag --- Tools and Scripts.
• Changing the generator itself --- tbdocs Internals, with builder/README.md next to the code.
• Adding a build task or a markdown-it plugin --- Extending the Builder covers all four extension points --- a task in the build graph, a markdown-it plugin, a render-worker sub-stage, and a verification gate in check.bat or test.bat.

Wayne Phillips & the documentation team