Public/waveterm
2
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2025-11-27 20:50:25 +08:00
Code Issues Projects Releases Packages Wiki Activity
waveterm/docs/README.md
Mike Sawka 88747742c9
 switch from yarn to npm (#2347) 
no need for yarn anymore in 2025 (especially yarn berry which is just an AI + githubactions nightmare). switch to the more standard npm.  update go version to 1.24 across the board.  cleanup some vite stuff, and deps.  all-around improvements.
2025-09-12 15:36:03 -07:00

893 B
Raw Permalink Blame History

Wave Terminal Documentation

This is the home for Wave Terminal's documentation site. This README is specifically about building and contributing to the docs site. If you are looking for the actual hosted docs, go here -- https://docs.waveterm.dev

Installation

Our docs are built using Docusaurus, a modern static website generator.

Local Development

task docsite

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

task docsite:build:<embedded,public>

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Deployments are handled automatically by the Docsite and Storybook CI/CD workflow