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
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,7 @@ jobs:

- name: Install dependencies
run: pnpm i
- name: Type Check
run: pnpm --filter website typecheck
- name: Test
run: pnpm t
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata
node_modules/
20 changes: 13 additions & 7 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,32 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati

### Installation

```
$ npm i
```sh
pnpm i
```

### Local Development

```
$ npm start
```sh
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

```
$ npm run build
```sh
pnpm build
```

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

### Type Check

```sh
pnpm typecheck
```

### Deployment

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.
Pushing to `main` deploys the site to GitHub Pages through the `deploy-website.yml` workflow.
6 changes: 5 additions & 1 deletion website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ const config: Config = {
deploymentBranch: 'main',

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
markdown: {
hooks: {
onBrokenMarkdownLinks: 'warn',
},
},

// Force trailing slashes on all URLs for GitHub pages.
trailingSlash: true,
Expand Down
1 change: 1 addition & 0 deletions website/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { JSX } from 'react';
import Link from '@docusaurus/Link';
import clsx from 'clsx';
import Heading from '@theme/Heading';
Expand Down
1 change: 1 addition & 0 deletions website/src/pages/index.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { JSX } from 'react';
import clsx from 'clsx';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import Layout from '@theme/Layout';
Expand Down
Loading