mirror of
https://github.com/wavetermdev/waveterm.git
synced 2024-12-21 16:38:23 +01:00
6400678686
There was a bug in Vite 6.0.1 (https://github.com/vitejs/vite/issues/18810) that was preventing NodeJS libraries from being bundled in the main process. This meant that our packaged app would refuse to run as it would be unable to find its Node libraries. This updates to Vite 6.0.2 to resolve this issue and also updates a few other deps while we're at it. Also removes the SASS modern-compiler config from our Vite config since this is the default behavior in Vite 6. closes #1373 |
||
---|---|---|
.. | ||
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