Source for the Kaspa documentation site - guides for integrating with and building on Kaspa.
The site is a Next.js app built with Fumadocs. Content is written in MDX.
| Path | Description |
|---|---|
content/docs/ |
The documentation pages (MDX). This is where most contributions land. |
examples/ |
Runnable code examples (Node.js, browser, Rust, Java) backing the integration guides. |
app/ |
Next.js app routes and layout. |
components/ |
React components used by the site and MDX content. |
lib/ |
Content source adapter and shared layout options. |
legacy/ |
The previous markdown-only documentation, kept for reference. Not published on the site. |
Reference/ |
Research material (papers, LaTeX sources). Not published on the site. |
npm install
npm run devOpen http://localhost:3000 to see the site.
CI runs these on every pull request - run them locally before pushing:
npm run lint
npm run format:check
npm run types:check
npm run buildContributions are welcome - see CONTRIBUTING.md. Missing documentation is tracked in the issues.