waveterm/waveterm-docs
0
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm-docs.git synced 2026-08-05 13:45:23 -07:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Evan Simkowitz
2024-09-19 13:03:45 -07:00
parent 5d24bade8d
commit 77348138a5
1 changed files with 19 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -20
View File
@@ -1,41 +1,40 @@
# Website <p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./static/img/logo/wave-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./static/img/logo/wave-light.png">
<img alt="Wave Terminal Logo" src="./static/img/logo/wave-light.png" width="240">
</picture>
<br/>
</p>
# Wave Terminal Documentation
This is the home for Wave Terminal's documentation site.
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation ### Installation
``` ```sh
$ yarn yarn
``` ```
### Local Development ### Local Development
``` ```sh
$ yarn start 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. 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 ### Build
``` ```sh
$ yarn build yarn build
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment ### Deployment
Using SSH: Deployments are handled automatically by the [Deploy action](.github/workflows/deploy.yml)
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.