Restructure repo: split apps/docs and packages/theme

Reorganize the project into a pnpm workspace: move the VitePress site into apps/docs and the theme into packages/theme (with its own package.json). Update root package.json scripts to build/dev the workspace, adjust pnpm-workspace.yaml and pnpm-lock. Update CI and deploy workflows, vercel.json and paths to use apps/docs/dist. Add ARCHITECTURE.md and README docs about the new layout. Introduce Disclaimer and FontSwitcher components and analytics toggle in the theme; adjust theme/config, exports, and styles. Rename/move many example/* files into apps/docs, update eslint ignores, and remove legacy example package files.

Author: RyouDYFZ

.all-contributorsrc

@@ -59,6 +59,6 @@
   "skipCi": true,
   "repoType": "github",
   "repoHost": "https://github.com",
-  "projectName": "vitepress-theme-project-trans",
-  "projectOwner": "mtfreport"
+  "projectName": "MtF.Report",
+  "projectOwner": "MtFReport-Team"
 }

.github/workflows/SyncTransMarkdown.yml

@@ -18,10 +18,10 @@ jobs:
 
       - name: Copy and commit file
         run: |
-          mkdir -p example/docs/zh-cn/references
-          cp temp_notes/trans.md example/docs/zh-cn/references/sbchild.md
+          mkdir -p apps/docs/zh-cn/references
+          cp temp_notes/trans.md apps/docs/zh-cn/references/sbchild.md
           git config --global user.name 'github-actions[bot]'
           git config --global user.email 'github-actions[bot]@users.noreply.github.com'
-          git add example/docs/zh-cn/references/sbchild.md
+          git add apps/docs/zh-cn/references/sbchild.md
           git commit -m "chore: sync sbchild.md from sb-child/notes" || echo "No changes"
           git push

.github/workflows/deploy.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: 9
+          version: 10.4.1
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
@@ -45,12 +45,12 @@ jobs:
         run: pnpm install
 
       - name: Build VitePress site
-        run: pnpm build && cd example && pnpm build # 或 pnpm build，取决于你的 package.json
+        run: pnpm build
 
       - name: Upload build artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: example/dist
+          path: apps/docs/dist
 
   deploy:
     name: Deploy to GitHub Pages

ARCHITECTURE.md

@@ -0,0 +1,89 @@
+# MtF.Report 仓库架构
+
+本仓库采用 pnpm workspace 管理，将“站点内容”和“VitePress 主题实现”分为两个独立工作区。
+
+```text
+MtF.Report/
+├── apps/
+│   └── docs/                 # MtF.Report 文档站
+│       ├── .vitepress/       # 站点配置与品牌样式
+│       ├── public/           # 静态资源
+│       ├── en/               # 英文内容
+│       ├── zh-cn/            # 简体中文内容
+│       └── zh-tw/            # 繁体中文内容
+├── packages/
+│   └── theme/                # 可复用的 VitePress 主题包
+│       └── src/
+│           ├── components/   # 页面与布局组件
+│           ├── plugins/      # VitePress 内容加载器
+│           ├── utils/        # 配置上下文与路径工具
+│           ├── config.ts     # VitePress 服务端配置入口
+│           └── theme.ts      # VitePress 客户端主题入口
+├── package.json              # 工作区统一命令
+├── pnpm-workspace.yaml       # 工作区声明
+└── vercel.json               # 生产部署配置
+```
+
+## 依赖方向
+
+```mermaid
+flowchart LR
+  Root["根工作区脚本"] --> Theme["packages/theme"]
+  Root --> Docs["apps/docs"]
+  Docs --> Theme
+  DocsConfig["apps/docs/.vitepress/config.ts"] --> ServerEntry["theme/config.ts"]
+  DocsTheme["apps/docs/.vitepress/theme/index.ts"] --> ClientEntry["theme/theme.ts"]
+  ClientEntry --> Layout["Layout 与 Components"]
+  ServerEntry --> Loaders["Sidebar 与 Content Loaders"]
+```
+
+依赖只允许从 `apps/docs` 指向 `packages/theme`。主题包不能反向读取站点内容，也不应硬编码 MtF.Report 的文案、品牌资源或部署路径。
+
+## 运行链路
+
+1. `apps/docs/.vitepress/config.ts` 创建站点配置，并通过 `withThemeContext` 把站点参数传给主题配置入口。
+2. `packages/theme/src/config.ts` 组装 Markdown 插件、侧边栏、内容统计和 Vite 插件。
+3. `apps/docs/.vitepress/theme/index.ts` 加载主题客户端入口。
+4. `packages/theme/src/theme.ts` 扩展 VitePress 默认主题并挂载自定义布局与客户端插件。
+5. `packages/theme/src/Layout.vue` 将页面信息、版权信息、页脚和辅助阅读组件插入 VitePress 插槽。
+
+## 目录职责
+
+### `apps/docs`
+
+- Markdown 内容、翻译和栏目结构。
+- MtF.Report 的颜色、字体、Logo、favicon 等品牌资源。
+- 域名、导航、语言、免责声明和部署输出目录等站点配置。
+
+### `packages/theme`
+
+- 通用布局和 Vue 组件。
+- VitePress/Markdown/Vite 插件组合。
+- 侧边栏生成、内容加载和配置上下文。
+- 对外导出的 `config`、`theme`、`components`、`utils` 四个入口。
+
+### 根目录
+
+- 统一开发、构建、检查命令。
+- workspace、CI、Vercel 和代码规范配置。
+- 项目级说明文档。
+
+## 常用命令
+
+```bash
+pnpm install
+pnpm dev
+pnpm build
+pnpm lint
+pnpm typecheck
+```
+
+`pnpm build` 会先构建主题包，再构建文档站，确保站点始终使用最新的本地主题产物。
+
+## 修改约定
+
+- 新文章和翻译放到 `apps/docs/<locale>/`。
+- 品牌样式放到 `apps/docs/.vitepress/theme/style.css`。
+- 可被其他站点复用的组件或构建能力放到 `packages/theme/src/`。
+- 新增主题公开能力时，同步维护 `packages/theme/package.json` 的 `exports`。
+- 调整目录时同步检查 GitHub Actions、Vercel 和内容同步脚本中的路径。

README.md

@@ -12,6 +12,30 @@ MtF.Report 是一个致力于研究与支持中国青少年跨性别女性（MtF
 
 本项目贡献者包括跨性别者等多元文化群体，请在贡献时尊重她们，使用友善礼貌的词语。
 
+## 仓库结构
+
+仓库已经按 pnpm workspace 拆分为两部分：
+
+- `apps/docs`：MtF.Report 的 VitePress 文档站、各语言内容和品牌资源。
+- `packages/theme`：文档站使用的 VitePress 主题、组件和构建配置。
+
+完整的模块职责、依赖方向与运行链路见 [ARCHITECTURE.md](./ARCHITECTURE.md)。
+
+## 本地开发
+
+```bash
+pnpm install
+pnpm dev
+```
+
+构建、代码检查和类型检查分别使用：
+
+```bash
+pnpm build
+pnpm lint
+pnpm typecheck
+```
+
 <div align="center">
   <img src="https://komarev.com/ghpvc/?username=mtfreport" style="display:inline-block;vertical-align:middle;" />
   <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
@@ -27,7 +51,7 @@ MtF.Report 是一个致力于研究与支持中国青少年跨性别女性（MtF
 <table>
   <tbody>
     <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://chiyu.it"><img src="https://avatars.githubusercontent.com/u/109492503?v=4?s=100" width="100px;" alt="池鱼鱼"/><br /><sub><b>池鱼鱼</b></sub></a><br /><a href="https://github.com/mtfreport/vitepress-theme-project-trans/commits?author=kazukokawagawa" title="Code">💻</a> <a href="#translation-kazukokawagawa" title="Translation">🌍</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://chiyu.it"><img src="https://avatars.githubusercontent.com/u/109492503?v=4?s=100" width="100px;" alt="池鱼鱼"/><br /><sub><b>池鱼鱼</b></sub></a><br /><a href="https://github.com/MtFReport-Team/MtF.Report/commits?author=kazukokawagawa" title="Code">💻</a> <a href="#translation-kazukokawagawa" title="Translation">🌍</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/CodingXiaoheng"><img src="https://avatars.githubusercontent.com/u/216361016?v=4?s=100" width="100px;" alt="CodingXiaoheng"/><br /><sub><b>CodingXiaoheng</b></sub></a><br /><a href="#content-CodingXiaoheng" title="Content">🖋</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/FengzihangCode"><img src="https://avatars.githubusercontent.com/u/91676896?v=4?s=100" width="100px;" alt="DannyFeng"/><br /><sub><b>DannyFeng</b></sub></a><br /><a href="#translation-FengzihangCode" title="Translation">🌍</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Hoshroin"><img src="https://avatars.githubusercontent.com/u/31343983?v=4?s=100" width="100px;" alt="Hosh"/><br /><sub><b>Hosh</b></sub></a><br /><a href="#research-Hoshroin" title="Research">🔬</a> <a href="#promotion-Hoshroin" title="Promotion">📣</a></td>
@@ -65,4 +89,4 @@ MtF.Report 是一个致力于研究与支持中国青少年跨性别女性（MtF
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
-该项目采用了 Project Trans 的 VitePress 主题 <https://github.com/project-trans/vitepress-theme-project-trans>
+该项目采用并维护了基于 Project Trans VitePress 主题的本地主题包：<https://github.com/project-trans/vitepress-theme-project-trans>

example/.gitignore apps/docs/.gitignoreexample/.gitignore renamed to apps/docs/.gitignore

@@ -12,5 +12,5 @@ dist
 dist-ssr
 *.local
 
-docs/.vitepress/cache
-components.d.ts
+.vitepress/cache
+.vitepress/components.d.ts

example/docs/.vitepress/config.ts apps/docs/.vitepress/config.tsexample/docs/.vitepress/config.ts renamed to apps/docs/.vitepress/config.ts

@@ -15,25 +15,25 @@ const nav: DefaultTheme.NavItem[] = [
 //      {
 //        text: '校园版块投稿指南',
 //        link: '/contributor-guide/doc.md',
- //     },
- //     {
- //       text: '其他投稿指南',
- //       link: '/contributor-guide/other.md',
- //     },
- //     {
- //       text: '校园版块贡献模板',
- //       link: '/contributor-guide/docTemplate.md',
+  //     },
+  //     {
+  //       text: '其他投稿指南',
+  //       link: '/contributor-guide/other.md',
+  //     },
+  //     {
+  //       text: '校园版块贡献模板',
+  //       link: '/contributor-guide/docTemplate.md',
   //    },
   //  ],
-  //},
+  // },
 ]
 
 const baseConfig = {
   useTitleFromFrontmatter: true,
   useFolderTitleFromIndexFile: true,
   useFolderLinkFromIndexFile: true,
   collapsed: true,
-  documentRootPath: '/docs',
+  documentRootPath: '/',
 } satisfies Partial<SidebarOptions>
 
 const sidebarOptions = [
@@ -45,43 +45,45 @@ const sidebarOptions = [
   },
   {
     ...baseConfig,
-    scanStartPath: 'en',       // 扫描 docs/en 下的 md
-    resolvePath: '/en/',       // 映射到 /en/ 下
+    scanStartPath: 'en',
+    resolvePath: '/en/',
     sortMenusByFrontmatterOrder: true,
   },
   {
     ...baseConfig,
-    scanStartPath: 'zh-tw',       // 扫描 docs/en 下的 md
-    resolvePath: '/zh-tw/',       // 映射到 /en/ 下
+    scanStartPath: 'zh-tw',
+    resolvePath: '/zh-tw/',
     sortMenusByFrontmatterOrder: true,
-  }
+  },
 ]
 
 const themeConfig: ThemeContext = {
   siteTitle: 'MtF.Report',
   siteDescription: '让世界看见她们',
+  hostName: 'https://mtf.report',
   // baseUrl: '/',
   /** Repo */
-  githubRepoLink: 'https://github.com/mtfreport/vitepress-theme-project-trans',
+  githubRepoLink: 'https://github.com/MtFReport-Team/MtF.Report',
   /** vitepress 根目录 */
-  rootDir: 'docs',
+  rootDir: '.',
   /** 文档所在目录（目前似未使用此项） */
   include: ['zh-cn', 'en'],
   nav,
   sidebarOptions,
   // enableChangeLog: false,
   enableSuggestionBox: false,
+  enableAnalytics: true,
   HideReadingTime: true, /* 隐藏字数和预计阅读时间 */
   HideLastUpdated: true, /* 隐藏最后更新时间 */
-  //HideAuthors: true, /* 隐藏作者信息 */
+  // HideAuthors: true, /* 隐藏作者信息 */
   // fontsBaseUrl: 'http://localhost:8788', // For local development with wrangler pages dev
   disclaimerPaths: [
     {
       path: '/zh-cn/',
       summaryHtml: 'MtF.Report 中的内容，仅供参考。可能存在过时或不准确的信息，请谨慎甄别。',
-//      detailHtml: '<p>RLE.wiki「大学指南」中的内容，仅供参考。可能存在过时或不准确的信息，请谨慎甄别。</p>'
-//        + '<p>「大学指南」板块中的内容，多数来自于读者投稿，并经编辑简单整理和形式审查后登载，主要体现其投稿者主观观点。不代表 RLE.wiki 编辑团队及我们的任何相关维护人员立场。</p>'
-//        + '<p>若存在任何有误或不当内容，请联系 <a href="mailto:rlewiki@project-trans.org">rlewiki@project-trans.org</a>。</p>',
+      //      detailHtml: '<p>RLE.wiki「大学指南」中的内容，仅供参考。可能存在过时或不准确的信息，请谨慎甄别。</p>'
+      //        + '<p>「大学指南」板块中的内容，多数来自于读者投稿，并经编辑简单整理和形式审查后登载，主要体现其投稿者主观观点。不代表 RLE.wiki 编辑团队及我们的任何相关维护人员立场。</p>'
+      //        + '<p>若存在任何有误或不当内容，请联系 <a href="mailto:rlewiki@project-trans.org">rlewiki@project-trans.org</a>。</p>',
     },
   ],
   enableDisclaimer: true,
@@ -119,10 +121,14 @@ const themeConfig: ThemeContext = {
 export default withThemeContext(themeConfig, () => {
   return {
     ...genConfig(),
-    outDir: '../dist',
+    ignoreDeadLinks: [
+      /^\.\/(?:README|sleep|emo|medicine2|trans-story)$/,
+      /^\.\/(?:mention|moments)\//,
+    ],
+    outDir: './dist',
     sitemap: {
-    hostname: 'https://mtf.report',
-    lastmodDateOnly: true
-  }
+      hostname: 'https://mtf.report',
+      lastmodDateOnly: true,
+    },
   }
 })

example/docs/.vitepress/theme/index.ts apps/docs/.vitepress/theme/index.tsexample/docs/.vitepress/theme/index.ts renamed to apps/docs/.vitepress/theme/index.ts

@@ -1,10 +1,6 @@
-// docs/.vitepress/theme/index.ts
 // https://vitepress.dev/guide/custom-theme
 import PtjsTheme from '@project-trans/vitepress-theme-project-trans/theme'
-import DefaultTheme from 'vitepress/theme-without-fonts'
 import 'uno.css'
 import './style.css'
 
-export default {
-  extends: PtjsTheme,DefaultTheme
-}
+export default PtjsTheme