Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Rigidity committed Jul 5, 2024
1 parent 00e1ddf commit efaac36
Showing 1 changed file with 11 additions and 27 deletions.
38 changes: 11 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,25 @@
# Website
# Rue Docs

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
Documentation for [Rue Lang](https://rue-lang.com), built using [Docusaurus](https://docusaurus.io/).

### Installation
## Installation

```
$ yarn
```bash
pnpm install
```

### Local Development
## Local Development

```
$ yarn start
```bash
pnpm 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
## Build

```
$ yarn build
```bash
pnpm build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

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

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

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.

0 comments on commit efaac36

Please sign in to comment.