贡献文档

注意

本教程为社区贡献，Open WebUI 团队不提供官方支持。它仅作为如何针对您的特定使用场景自定义 Open WebUI 的演示。想要贡献？请查看贡献教程。

我们非常感谢您有兴趣为 Open WebUI 文档贡献教程。请按照以下步骤设置您的环境并提交您的教程。

贡献步骤

1. Fork open-webui/docs GitHub 仓库

   • 在 GitHub 上前往 Open WebUI Docs Repository。
   • 点击右上角的 Fork 按钮，在您的 GitHub 账号下创建一个副本。

2. 启用 GitHub Actions

   • 在您 Fork 的仓库中，前往 Actions 选项卡。
   • 如果有提示，请按照屏幕上的说明启用 GitHub Actions。

3. 启用 GitHub Pages

   • 前往您 Fork 的仓库中的 Settings > Pages。
   • 在 Source 下，选择您要部署的分支（例如 main）和文件夹（例如 /docs）。
   • 点击 Save 以启用 GitHub Pages。

4. 配置 GitHub 环境变量

   • 在您 Fork 的仓库中，前往 Settings > Secrets and variables > Actions > Variables。
   • 添加以下环境变量：
     • BASE_URL 设置为 /docs（或您为 Fork 副本选择的基准 URL）。
     • SITE_URL 设置为 https://<your-github-username>.github.io/。

📝 更新 GitHub Pages Workflow 和配置文件

如果您需要调整部署设置以适应您的自定义配置，请执行以下操作：

a. 更新 .github/workflows/gh-pages.yml

• 如有必要，在 build 步骤中为 BASE_URL 和 SITE_URL 添加环境变量：

    - name: Build
      env:
        BASE_URL: ${{ vars.BASE_URL }}
        SITE_URL: ${{ vars.SITE_URL }}
      run: npm run build

b. 修改 docusaurus.config.ts 以使用环境变量

• 更新 docusaurus.config.ts 以使用这些环境变量，并为本地或直接部署设置默认值：

  const config: Config = {
    title: "Open WebUI",
    tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
    favicon: "images/favicon.png",
    url: process.env.SITE_URL || "https://openwebui.com",
    baseUrl: process.env.BASE_URL || "/",
    ...
  };

• 此配置可确保 Fork 副本和自定义配置的部署行为保持一致。

5. 运行 gh-pages GitHub Workflow

   • 在 Actions 选项卡中，找到 gh-pages workflow。
   • 如有必要，手动触发该 workflow，或者它也可能会根据您的设置自动运行。

6. 浏览至您 Fork 的副本

   • 访问 https://<your-github-username>.github.io/<BASE_URL> 以查看您 Fork 的文档。

7. 起草您的修改

   • 在您 Fork 的仓库中，导航到相应的目录（例如 docs/tutorial/）。
   • 为您的教程创建一个新的 markdown file，或编辑现有的文件。
   • 确保您的教程包含“不支持”的警告横幅。

8. 提交 Pull Request

   • 您的教程准备就绪后，将更改 commit 到您 Fork 的仓库中。
   • 导航到原始的 open-webui/docs 仓库。
   • 点击 New Pull Request，然后选择您的 Fork 副本和分支作为源。
   • 为您的 PR 提供一个描述性的标题和描述。
   • 提交 pull request 以供审核。

重要事项

社区贡献的教程必须包含以下内容：

:::warning

本教程为社区贡献，Open WebUI 团队不提供官方支持。它仅作为如何针对您的特定使用场景自定义 Open WebUI 的演示。想要贡献？请查看贡献教程。

:::

---

提示

如何在本地测试 Docusaurus 您可以使用以下命令在本地测试您的 Docusaurus 站点：

npm install   # 安装依赖项
npm run build # 构建用于生产环境的站点

这将在部署前帮助您发现任何问题

---