贡献教程

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

步骤

分叉 openwebui/docs GitHub 仓库
- 前往 Open WebUI 文档仓库在 GitHub 上。
- 点击右上角的 Fork（分叉）按钮，以在您的 GitHub 账户下创建一个副本。
启用 GitHub Actions
- 在您派生（forked）的仓库中，导航到 Actions（操作）选项卡。
- 如果出现提示，请按照屏幕上的说明启用 GitHub Actions。
启用 GitHub Pages
- 在您派生（forked）的仓库中，前往 Settings（设置）> Pages（页面）。
- 在 Source（源）下，选择您要部署的分支（例如，main）和文件夹（例如，/docs）。
- 点击 Save（保存）以启用 GitHub Pages。
配置 GitHub 环境变量
- 在您派生（forked）的仓库中，前往 Settings（设置）> Secrets and variables（密钥和变量）> Actions（操作）> Variables（变量）。
- 添加以下环境变量
  - BASE_URL 设置为 /docs（或您为派生（forked）仓库选择的基础 URL）。
  - SITE_URL 设置为 https://<your-github-username>.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.cn",
  baseUrl: process.env.BASE_URL || "/",
  ...
};

此设置确保派生（forked）仓库和自定义配置的部署行为一致。

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

重要

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

:::warning
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
:::

如何在本地测试 Docusaurus

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

npm install   # Install dependencies
npm run build # Build the site for production

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

步骤​

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

重要​

步骤

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

重要