贡献教程

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

步骤

Fork openwebui/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://<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",
  baseUrl: process.env.BASE_URL || "/",
  ...
};

此设置确保fork和自定义设置的一致部署行为。

运行gh-pages GitHub工作流
- 在Actions标签中，找到gh-pages工作流。
- 如有必要，手动触发工作流，或者它可能根据您的设置自动运行。
浏览您的fork副本
- 访问https://<your-github-username>.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的演示。想要贡献？请查看贡献教程。
:::

如何在本地测试Docusaurus

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

npm install   # 安装依赖项
npm run build # 为生产构建站点

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

步骤​

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

重要​

步骤

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

重要