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.md (#88)

Browse Source
This commit is contained in:
Evan Simkowitz
2024-11-06 20:54:16 +00:00
committed by GitHub
parent 80c6ce88df
commit c4f38363b7
1 changed files with 1 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -38
View File
@@ -1,40 +1,3 @@
<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 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](https://docusaurus.io/), a modern static website generator.
```sh
yarn
```
### Local Development
```sh
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
```sh
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 [Deploy action](.github/workflows/deploy.yml)
This repository is archived. The source code for Wave's documentation site can now be found [here](https://github.com/wavetermdev/waveterm/blob/main/docs).