Skip to content

Commit

Permalink
fix: rebuild docs with jekyll disabled
Browse files Browse the repository at this point in the history
  • Loading branch information
retr0h committed Dec 29, 2023
1 parent 1d60581 commit c9b6b4b
Showing 1 changed file with 2 additions and 24 deletions.
26 changes: 2 additions & 24 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,18 @@

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

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
$ task 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

```
$ yarn build
$ task 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 c9b6b4b

Please sign in to comment.