Skip to content

catalyst-network/catalyst-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 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 the current setup (custom domain), the site is served from the domain root:
    • https://docs.catalystnet.org/
  • If you host as a GitHub Pages project site instead, the site is served under /<repo>/ and Docusaurus must use baseUrl: "/catalyst-docs/".

About

Online documentation for the Catalyst blockchain

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors