The NativeLink documentation

The NativeLink documentation gets deployed to <https://docs.nativelink.com>.

📚 Stack

The NativeLink documentation uses a custom, highly efficient, high performance stack. Getting a bunch of bleeding-edge tools to work well together can be challenging. Feel free to copy-paste it into your own projects.

• Diátaxis as overarching documentation philosophy.
• Bun as production bundler.
• Biome as linting toolchain.
• Astro as meta-framework.
• Starlight as documentation framework.
• TailwindCSS 4.0-alpha for component styling which makes use of LightningCSS for faster CSS processing.
• Deno Deploy for deployments.

🚀 Common workflows

See docs/package.json for build scripts.

This project requires bun and deno. The nix flake ships compatible versions.

# Install dependencies with bun.
bun install

# Rebuild the docs reference. (Note MacOS: Use Bun & Bazel from Host)
bun run docs.build

# Generate the simple parts of the autogenerated docs.
bun run docs.generate

# Rebuild everything. Make sure to remove the `dist` directory beforehand.
bun run build

# Serve the dist directory with deno
bun serve

# Run a development server. Doesn't rebuild the autogenerated parts of the docs.
bun dev

# Run formatter and linter checks.
bun check

# Apply formatter and linter fixes.
bun fix

# Test Deno deployments locally. Useful when debugging SSR. Rebuilds the
# autogenerated parts of the docs.
bun preview

🐛 Known issues

• bun run docs.build doesn’t work on MacOS with the nix version of Bazel. As a workaround install Bun and Bazel on your host and build the docs outside the flake.
• bun dev doesn’t reload the changes in the starlight.conf.ts