User & developer documentation for the FEAScript project, published at https://docs.feascript.com. Built with Docusaurus (Node.js >= 20).
npm install
npm start # dev server with live reload
npm run build # production build into ./build
npm run serve # serve the production build locally- Pages are Markdown/MDX files under
docs/; the sidebar is defined insidebars.js. - Math is supported with KaTeX: inline
$T$and block$$ ... $$. docs/always holds the unreleased docs ("0.3.0-RC (dev)" in the version dropdown).
The theme follows the design tokens of feascript.com: cream "engineering paper" with a blueprint grid, charcoal ink, gold accent, a floating pill navbar, always-dark code blocks, and Roboto / Roboto Mono, with a matching dark mode. The footer uses the website's footer color (#f6efd9, #222222 in dark mode). Colors and component styling live in src/css/custom.css; fonts and the code theme are set in docusaurus.config.js.
The navbar's GitHub pill matches the website and fetches the FEAScript-core star count from the public GitHub API in the browser. If the request fails, the link remains usable without a count and the error is logged to the browser console.
When a new FEAScript-core version is released, snapshot the current docs:
npm run version -- 0.3.0This copies docs/ to versioned_docs/version-0.3.0/, the sidebar to versioned_sidebars/, and records the version in versions.json. Released docs are then available at docs.feascript.com/0.3.0/... and appear in the version dropdown.
Versions appear inside that dropdown, not as separate links across the navbar. The space between the logo and the right-hand controls is flexible layout spacing.
After the first release, edit docusaurus.config.js: remove lastVersion: "current" so the newest released version becomes the default (unversioned URLs). Fixes to an old version are made directly in its versioned_docs/version-x.y.z/ folder.
Pushing to main triggers .github/workflows/deploy.yml, which builds the site and deploys it to docs.feascript.com
The content of the FEAScript documentation is licensed under CC-BY 4.0. Note that the core library of FEAScript is distributed under the terms of the MIT license.