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

Commit

Permalink
Update README.md (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
esimkowitz authored Nov 6, 2024
1 parent 80c6ce8 commit c4f3836
Showing 1 changed file with 1 addition and 38 deletions.
39 changes: 1 addition & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit c4f3836

Please sign in to comment.