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
71 changes: 45 additions & 26 deletions .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
@@ -1,54 +1,73 @@
name: Publish to GitHub pages
name: Build and deploy

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

permissions:
contents: write
pages: write
id-token: write
contents: read

concurrency:
group: "pages"
cancel-in-progress: false
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
Github-Pages-Release:
build:
timeout-minutes: 10

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest

steps:
- uses: pnpm/action-setup@v4
with:
version: 8

- name: Checkout
uses: actions/checkout@v4
uses: actions/checkout@v7

- name: Setup pnpm
uses: pnpm/action-setup@v6

- name: Setup Node
uses: actions/setup-node@v7
with:
node-version-file: .nvmrc
cache: pnpm

- name: Install dependencies
run: pnpm install
run: pnpm install --frozen-lockfile

- name: Prettier
run: pnpm prettier

- name: Build with Trunk
run: pnpm build
- name: Typecheck
run: pnpm typecheck

- name: Setup GitHub Pages
uses: actions/configure-pages@v4
- name: Build
run: pnpm build

- name: Upload artifact
uses: actions/upload-pages-artifact@v4
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v5
with:
path: "./build"
path: ./build

deploy:
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
needs: build
timeout-minutes: 10
runs-on: ubuntu-latest

permissions:
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

- name: Deploy to GitHub Pages 🚀
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v5
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
24
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Documentation for [Rue Lang](https://rue-lang.com), built using [Docusaurus](https://docusaurus.io/).

## Requirements

- Node.js 24 (see `.nvmrc`)
- pnpm 12 (pinned via `packageManager` in `package.json`)

## Installation

```bash
Expand All @@ -23,3 +28,13 @@ pnpm build
```

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

## Checks

CI runs these on every pull request:

```bash
pnpm prettier
pnpm typecheck
pnpm build
```
11 changes: 6 additions & 5 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ const config: Config = {
favicon: "img/favicon.ico",
url: "https://rue-lang.com",
baseUrl: "/",
organizationName: "xch-dev",
projectName: "Rue",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
markdown: {
hooks: {
onBrokenMarkdownLinks: "throw",
},
},
i18n: {
defaultLocale: "en",
locales: ["en"],
Expand All @@ -33,8 +35,7 @@ const config: Config = {
],

themeConfig: {
// Replace with your project's social card
image: "img/docusaurus-social-card.jpg",
image: "img/rue.png",
navbar: {
title: "Rue Lang",
logo: {
Expand Down
37 changes: 20 additions & 17 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
Expand All @@ -16,22 +15,25 @@
"prettier": "prettier --check ."
},
"dependencies": {
"@docusaurus/core": "3.4.0",
"@docusaurus/preset-classic": "3.4.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0",
"prismjs": "^1.29.0",
"react": "^18.0.0",
"react-dom": "^18.0.0"
"@docusaurus/core": "3.10.2",
"@docusaurus/preset-classic": "3.10.2",
"@mdx-js/react": "^3.1.1",
"clsx": "^2.1.1",
"prism-react-renderer": "^2.4.1",
"prismjs": "^1.30.0",
"react": "^19.3.1",
"react-dom": "^19.3.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.4.0",
"@docusaurus/tsconfig": "3.4.0",
"@docusaurus/types": "3.4.0",
"@types/prismjs": "^1.26.4",
"prettier": "^3.3.2",
"typescript": "~5.2.2",
"@docusaurus/module-type-aliases": "3.10.2",
"@docusaurus/theme-classic": "3.10.2",
"@docusaurus/tsconfig": "3.10.2",
"@docusaurus/types": "3.10.2",
"@types/node": "^24.19.2",
"@types/prismjs": "^1.26.6",
"@types/react": "^19.2.0",
"prettier": "^3.9.10",
"typescript": "~5.9.3",
"utility-types": "^3.11.0"
},
"browserslist": {
Expand All @@ -47,6 +49,7 @@
]
},
"engines": {
"node": ">=18.0"
}
"node": ">=20.0"
},
"packageManager": "pnpm@12.18.0"
}
Loading
Loading