Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Chivier committed Aug 12, 2024
1 parent d05e017 commit 3f2d557
Showing 1 changed file with 16 additions and 26 deletions.
42 changes: 16 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,31 @@
# Website
# ServelessLLM Docs

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

### Installation
## Installation

```
$ yarn
```

### Local Development
To install the necessary dependencies, use the following command:

```
$ yarn start
```bash
npm install
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Local Development

### Build
To start a local development server and open up a browser window, use the following command:

```
$ yarn build
```bash
npm run start
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
Most changes are reflected live without having to restart the server.

### Deployment
## Build

Using SSH:
To generate static content into the build directory, use the following command:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```bash
npm run build
```

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.
This command generates static content into the `build` directory, which can be served using any static content hosting service.

0 comments on commit 3f2d557

Please sign in to comment.