Skip to content

catalyst-network/catalyst-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Catalyst Docs

Single, public documentation hub for the Catalyst ecosystem (operators, wallets, builders, protocol + RPC reference).

Local development

Prereqs:

  • Node.js >= 20

Install:

npm install

Run locally:

npm run start

Build:

npm run build

Serve the production build locally:

npm run serve

Repo layout

  • site/: Docusaurus app (config, theme, docs content)

Deploy (GitHub Pages)

This repo is set up to build the site on every PR, and deploy site/build/ to GitHub Pages on merges to main.

Notes:

  • For project pages, Docusaurus uses baseUrl: "/catalyst-docs/".
  • The deployed URL will be the org GitHub Pages host + repo path (example: https://catalyst-network.github.io/catalyst-docs/).

About

Online documentation for the Catalyst blockchain

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors