Skip to content
xch-devPublic

About

Rue programming language documentation.

Resources

Security policy

Stars

1 star

Watchers

1 watching

Forks

Repository files navigation

Rue Docs

Documentation for Rue Lang, built using Docusaurus.

Requirements

  • Node.js 24 (see .nvmrc)
  • pnpm 12 (pinned via packageManager in package.json)

Installation

pnpm install

Local Development

pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

Checks

CI runs these on every pull request:

pnpm prettier
pnpm typecheck
pnpm build

CI also checks the Rue examples in the docs, with the Rue CLI at the version in .rue-version. To run the check locally, install that version (cargo install rue-cli --version <version>) and run:

pnpm check:rue-examples

Every ```rue block must compile without errors or warnings, pass its tests, and be formatted the way rue fmt formats it. See scripts/check-rue-examples.py for the info strings (such as ```rue ignore) that change what's checked for a block.

Updating for a Rue release

The docs describe the Rue version in .rue-version. The update-rue-docs skill in .claude/skills updates them for a new release: run /update-rue-docs [version] in Claude Code.

About

Rue programming language documentation.

Resources

Security policy

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages