参与贡献

文档仓库

本文档网站的所有内容都在公开仓库，您可以使用 Git 与 GitHub 完成对此文档的贡献。本文假设您对 Git 和 GitHub 有一定的了解，并有一定的操作经验。

文档规范

• 文件与目录用数字前缀 1.xxx 2.xxx 控制侧边栏顺序
• 每个文件夹配一个 .navigation.yml，写明 title 与可选的 navigation.icon
• 每页的 frontmatter 必须有 title 和 description
• 图标取自 Lucide，写成 i-lucide-git-pull-request 的形式
• 图片放在 public/ 下，目录结构与文档一一对应，去掉数字前缀。例如 content/4.client/1.gui/1.loliafrpclient/2.Windows.md 对应 public/client/gui/loliafrpclient/Windows/

推荐在一级菜单和二级菜单上都添加icon，深入的层级则不添加。如果您不确定选择什么，可以留空。

提交 Pull Request

1. 在 GitHub 网页端 Fork 仓库
   
2. Clone 您的 Fork 到本地：

   git clone https://github.com/<您的用户名>/loliafrp-docs.git
   cd loliafrp-docs
   

3. 新建分支后修改 content/ 下对应的文件：

   git checkout -b docs/fix-typo
   

4. 提交并推送到自己的仓库，然后回到 GitHub 发起 Pull Request，简述您的改动。

本地预览

文档基于 Nuxt Content + Docus 构建，本地预览需要 Bun：

bun install
bun dev

如果Node版本过高，可以尝试使用

npm install --no-package-lock
npm run dev

打开终端里输出的地址即可，您的改动会自动热更新并显示。

许可证

原创文档内容采用 CC BY-NC-SA 4.0 许可，完整声明见仓库中的 content/LICENSE。

引用了 frp 或其他开源项目的内容，仍遵循其各自的许可证。如果发现有漏标来源的地方，欢迎提醒我们。