firedancer/book at main · firedancer-io/firedancer · GitHub

Name		Name	Last commit message	Last commit date
parent directory ..
.vitepress		.vitepress
api		api
guide		guide
images		images
public		public
snippets		snippets
README.md		README.md
index.md		index.md
package.json		package.json

README.md

Getting Started

This book is served with VitePress. You can see the VitePress getting started guide at https://vitepress.dev/guide/getting-started.

Developing

Install bun, curl -fsSL https://bun.sh/install | bash
Make it available in PATH, source ~/.bashrc
Make sure the working directory is firedancer/book
bun install
bun run dev

Note

If you're running this on a remote host, run: bun run dev --host to expose the endpoint.

This will serve a local docs site.