mirror of
https://github.com/wavetermdev/waveterm.git
synced 2025-01-17 20:51:55 +01:00
3216bc2389
Renames defaultwidgets.json file in defaultconfig to widgets.json and removes references to defaultwidgets in the codebase and documentation. Going forward, users will see one unified list of widgets in the sidebar with no separator between default and custom widgets. Users can manually move any edits to their defaultwidgets.json file into their widgets.json file to get back their overrides. |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| .prettierignore | ||
| .remarkrc | ||
| .yarnrc.yml | ||
| 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
yarn start
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
yarn build
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