贡献教程

warning

本教程是由社区贡献的，不属于 Open WebUI 团队的支持范围。它仅作为如何针对特定用例自定义 Open WebUI 的演示。想要贡献？请查看贡献教程。

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

贡献步骤

Fork open-webui/docs GitHub 仓库
- 在 GitHub 上导航到 Open WebUI 文档仓库。
- 点击右上角的 Fork 按钮，在您的 GitHub 账户下创建一个副本。
启用 GitHub Actions
- 在您 Fork 的仓库中，导航到 Actions 选项卡。
- 如果有提示，请按照屏幕上的说明启用 GitHub Actions。
启用 GitHub Pages
- 转到您 Fork 仓库中的 Settings > Pages。
- 在 Source 下，选择您要部署的分支（例如 main）和文件夹（例如 /docs）。
- 点击 Save 以启用 GitHub Pages。
配置 GitHub 环境变量
- 在您 Fork 的仓库中，转到 Settings > Secrets and variables > Actions > Variables。
- 添加以下环境变量：
  - BASE_URL 设置为 /docs（或您为 Fork 选择的基础 URL）。
  - SITE_URL 设置为 https://<您的-github-用户名>.github.io/。

📝 更新 GitHub Pages 工作流和配置文件

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

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

如果有必要，在构建步骤中为 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 和自定义设置的部署行为一致。

运行 gh-pages GitHub 工作流
- 在 Actions 选项卡中，找到 gh-pages 工作流。
- 如果有必要，手动触发工作流，或者它可能会根据您的设置自动运行。
浏览您 Fork 的副本
- 访问 https://<您的-github-用户名>.github.io/<BASE_URL> 以查看您 Fork 的文档。
起草您的更改
- 在您 Fork 的仓库中，导航到适当的目录（例如 docs/tutorial/）。
- 为您的教程创建一个新的 Markdown 文件，或编辑现有文件。
- 确保您的教程包含不支持的警告横幅。
提交 Pull Request
- 教程准备就绪后，将更改提交到您 Fork 的仓库。
- 导航到原始的 open-webui/docs 仓库。
- 点击 New Pull Request，并选择您的 Fork 和分支作为源。
- 为您的 PR 提供一个描述性的标题和描述。
- 提交 Pull Request 以供审核。

重要提示

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

:::warning

本教程是由社区贡献的，不属于 Open WebUI 团队的支持范围。它仅作为如何针对特定用例自定义 Open WebUI 的演示。想要贡献？请查看贡献教程。

:::

tip

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

npm install   # 安装依赖
npm run build # 为生产环境构建网站

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

贡献步骤​

📝 更新 GitHub Pages 工作流和配置文件​

重要提示​

贡献步骤

📝 更新 GitHub Pages 工作流和配置文件

重要提示