Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/gh_pages_deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ jobs:
- name: Checkout code
uses: actions/checkout@v3

- name: Set up Node.js
uses: actions/setup-node@v3
- name: Set up Bun
uses: oven-sh/setup-bun@v2
with:
node-version: 'lts/krypton'
bun-version: "1.3.14"

- name: Install dependencies
working-directory: ./website
run: npm install
run: bun install --frozen-lockfile

- name: Build Docusaurus
working-directory: ./website
run: npm run build
run: bun run build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
Expand Down
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,8 @@ Cargo.lock
# VsCode
.vscode

# Mac OSß
.DS_Store
# Mac OS
.DS_Store

# Local files
*.local.*
1 change: 1 addition & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
bun 1.3.14
5 changes: 5 additions & 0 deletions website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,11 @@ dist
npm-debug.log*
yarn-debug.log*
yarn-error.log*
bun-error.log
package-lock.json

# Yarn Lock
yarn.lock

# Local files
*.local.*
41 changes: 24 additions & 17 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,57 @@
# Website

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

## Quick Start

First, ensure you're using the correct Node.js version:
Requires [Bun](https://bun.sh/) (`>= 1.0.0`). Install it via:

```bash
nvm install
nvm use
curl -fsSL https://bun.sh/install | bash
```

### Installation
Or with `asdf`/`mise` — the repo's `.tool-versions` pins the exact version:

```bash
asdf install
# or
mise install
```
npm install

### Installation

```bash
bun install
```

### Local Development

```
npm start
```bash
bun run 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.
Starts a local development server and opens a browser window. Most changes are reflected live without restarting.

### Build

```
npm run build
```bash
bun run build
```

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

### Deployment

Using SSH:

```
USE_SSH=true npm run deploy
```bash
USE_SSH=true bun run deploy
```

Not using SSH:

```
GIT_USER=<Your GitHub username> npm run deploy
```bash
GIT_USER=<Your GitHub username> bun run 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.
If you are using GitHub Pages for hosting, this command builds the website and pushes to the `gh-pages` branch.
2,653 changes: 2,653 additions & 0 deletions website/bun.lock

Large diffs are not rendered by default.

Loading
Loading