use astro

Author: ZnPdCo

.github/workflows/deploy-manual.yml

@@ -0,0 +1,45 @@
+name: Deploy Manual
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: ./manual
+
+      - name: Build
+        run: npm run build
+        working-directory: ./manual
+
+      - name: Create nojekyll
+        run: echo > ./manual/dist/.nojekyll
+
+      - name: Deploy to gh-pages branch
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./manual/dist

manual/.gitignore

@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

manual/README.md

@@ -2,7 +2,7 @@
 
 该文件夹储存 LemonLime 用户手册源代码。
 
-用户手册使用 Typst 编写，源代码储存于 `docs` 目录中。
+用户手册使用 Typst 编写，源代码储存于 `manual/src/content` 目录中。
 
 用户手册有两种分发模式：线上分发与线下分发。
 
@@ -13,10 +13,6 @@
 - [LXGW WenKai](https://github.com/lxgw/LxgwWenKai/releases)
 - [Courier Prime Code](https://quoteunquoteapps.com/courierprime/downloads/courier-prime-code.zip)
 
-然后使用 Typst CLI 或者 Tinymist Typst 编译 `manual/docs/manual.typ`，将生成出来的 pdf 重命名并放在 `manual/llmanual.pdf`。
+然后使用 Typst CLI 或者 Tinymist Typst 编译 `manual/src/content/manual.typ`，将生成出来的 pdf 重命名并放在 `manual/llmanual.pdf`。
 
-线上分发使用 pandoc 将 typst 文件转换为 md 文件，然后使用 [material for mkdocs](https://squidfunk.github.io/mkdocs-material/) 部署于线上。
-
-转换工具存储于 `scripts/build_html.py` 中，需要 pandoc。在项目根目录下使用 `python ./manual/scripts/build_html.py` 调用。生成出来的文件在 `site` 目录下。
-
-`docs` 文件夹已经使用 `.gitignore` 忽略除了 `index.md`（需要特殊处理主页） 外的 `.md` 文件。
+线上分发使用使用 astro+[astro-typst](https://github.com/OverflowCat/astro-typst)+[starlight theme](https://starlight.astro.build/) 部署于线上。

manual/astro.config.mjs

@@ -0,0 +1,39 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import { typst } from 'astro-typst';
+
+// https://astro.build/config
+export default defineConfig({
+	site: 'https://project-lemonlime.github.io',
+	base: 'Project_LemonLime',
+	integrations: [
+		starlight({
+			title: 'LemonLime Manual',
+			tableOfContents: false,
+			favicon: '/favicon.png',
+			social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/Project-LemonLime/Project_LemonLime' }],
+			sidebar: [
+				{
+					label: 'Manual',
+					items: [
+						{ label: '快速开始', slug: 'quickstart' },
+						{ label: '简介', slug: 'intro' },
+						{ label: '安装', slug: 'install' },
+						{ label: '设置', slug: 'settings' },
+						{ label: '比赛', slug: 'contest' },
+						{ label: '测试', slug: 'judge' },
+						{ label: '比赛统计', slug: 'statistics' },
+						{ label: '常见问题及回答', slug: 'issue' },
+					],
+				},
+			],
+		}),
+		typst({
+			options: {
+				remPx: 14,
+			},
+			target: "html",
+		}),
+	],
+});