Skip to content
This repository has been archived by the owner on Mar 9, 2023. It is now read-only.

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
depombo committed Nov 7, 2022
1 parent 0f7270a commit 1c552ea
Showing 1 changed file with 2 additions and 36 deletions.
38 changes: 2 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,3 @@
# Website
# Documentation

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start:local
```

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.

### Version

```
$ yarn run docusaurus docs:version $VERSION
```

This command generates a copy of the latest docs under `versioned_docs` with the provided $VERSION

### Deployment

Use the github actions `deploy` job
The documentation now lives in https://github.com/iasql/iasql-engine/tree/main/site/docs

0 comments on commit 1c552ea

Please sign in to comment.