Skip to content

Commit

Permalink
changing the README & cleaning up
Browse files Browse the repository at this point in the history
  • Loading branch information
LukBelter committed Apr 30, 2024
1 parent 3bb5e2d commit b0b15bf
Show file tree
Hide file tree
Showing 4 changed files with 5,787 additions and 13,039 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
changed_files=$(gh pr diff --name-only ${{ github.event.pull_request.number }}) #todo: Maybe change to git diff to avoid 300 diff limit?
changed_files=$(gh pr diff --name-only ${{ github.event.pull_request.number }})
test=false
for file in $changed_files; do
Expand Down
22 changes: 7 additions & 15 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,29 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
### Installation

```
$ yarn
$ pnpm install
```

### Local Development

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

```
$ yarn build
$ 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
$ pnpm serve
```

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.
:::info INFO
For the search to work locally, the website must be built using `pnpm build`
:::
Loading

0 comments on commit b0b15bf

Please sign in to comment.