biomejs.dev

The website source of biomejs/biome.

Clone

To clone the repository, run

git clone https://github.com/biomejs/website

Installation

First install pnpm by enabling corepack:

corepack enable

Then install the required dependencies:

pnpm i --frozen-lockfile

Local Development

This command starts a local development server:

pnpm start

Most changes are reflected live without having to restart the server.

Code generation

The pages of the lint rules are all code generated from the repository biomejs/biome. To update the pages you have to install the Rust toolchain, because the code that does that requires reading the source code of the analyzer.

First, make sure that you've pulled the latest version of the repository and installed the required toolchains, then run the corresponding scripts from the repo root via pnpm:

# generate only rules files
pnpm codegen:rules

# generate only rules metadata
pnpm codegen:metadata

# generate only release files
pnpm codegen:release-files

# generate all files
pnpm codegen:all

Build

This command generates static content into the dist directory:

pnpm build

The dist directory can be served using any static contents hosting service, or you can preview the site locally with

pnpm preview