mirror of
https://github.com/wavetermdev/waveterm.git
synced 2025-01-18 21:02:00 +01:00
|
|
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| .prettierignore | ||
| .remarkrc | ||
| babel.config.js | ||
| docusaurus.config.ts | ||
| eslint.config.js | ||
| package.json | ||
| prettier.config.cjs | ||
| README.md | ||
| tsconfig.json | ||
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.
yarn
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