Skip to content
This repository was archived by the owner on Nov 6, 2024. It is now read-only.

Commit c4f3836

Browse files
authored
Update README.md (#88)
1 parent 80c6ce8 commit c4f3836

File tree

1 file changed

+1
-38
lines changed

1 file changed

+1
-38
lines changed

README.md

+1-38
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,3 @@
1-
<p align="center">
2-
<picture>
3-
<source media="(prefers-color-scheme: dark)" srcset="./static/img/logo/wave-dark.png">
4-
<source media="(prefers-color-scheme: light)" srcset="./static/img/logo/wave-light.png">
5-
<img alt="Wave Terminal Logo" src="./static/img/logo/wave-light.png" width="240">
6-
</picture>
7-
<br/>
8-
</p>
9-
101
# Wave Terminal Documentation
112

12-
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
13-
14-
### Installation
15-
16-
Our docs are built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
17-
18-
```sh
19-
yarn
20-
```
21-
22-
### Local Development
23-
24-
```sh
25-
yarn start
26-
```
27-
28-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
29-
30-
### Build
31-
32-
```sh
33-
yarn build
34-
```
35-
36-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
37-
38-
### Deployment
39-
40-
Deployments are handled automatically by the [Deploy action](.github/workflows/deploy.yml)
3+
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).

0 commit comments

Comments
 (0)