centersl/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2026-03-26 13:18:42 +07:00
Code Issues Packages Projects Releases Wiki Activity

Markdownlit corrections in formatting

Browse Source 
Markdownlit corrections in formatting
This commit is contained in:
Silentoplayz
2024-12-17 17:11:14 -05:00
parent 1e1faa846b
commit fb8d31985e
63 changed files with 307 additions and 164 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/tutorials/tips/contributing-tutorial.md
View File

@@ -29,7 +29,6 @@ We appreciate your interest in contributing tutorials to the Open WebUI document
- Under **Source**, select the branch you want to deploy (e.g., `main`) and the folder (e.g.,`/docs`).
- Click **Save** to enable GitHub Pages.
4. **Configure GitHub Environment Variables**
- In your forked repository, go to **Settings** > **Secrets and variables** > **Actions** > **Variables**.
@@ -42,7 +41,9 @@ We appreciate your interest in contributing tutorials to the Open WebUI document
If you need to adjust deployment settings to fit your custom setup, here’s what to do:
a. **Update `.github/workflows/gh-pages.yml`**
- Add environment variables for `BASE_URL` and `SITE_URL` to the build step if necessary:
- Add environment variables for `BASE_URL` and `SITE_URL` to the build step if necessary:
```yaml
- name: Build
env:
@@ -52,7 +53,9 @@ a. **Update `.github/workflows/gh-pages.yml`**
```
b. **Modify `docusaurus.config.ts` to Use Environment Variables**
- Update `docusaurus.config.ts` to use these environment variables, with default values for local or direct deployment:
- Update `docusaurus.config.ts` to use these environment variables, with default values for local or direct deployment:
```typescript
const config: Config = {
title: "Open WebUI",
@@ -63,7 +66,8 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables**
...
};
```
- This setup ensures consistent deployment behavior for forks and custom setups.
- This setup ensures consistent deployment behavior for forks and custom setups.
5. **Run the `gh-pages` GitHub Workflow**
@@ -91,6 +95,7 @@ b. **Modify `docusaurus.config.ts` to Use Environment Variables**
## Important
Community-contributed tutorials must include the the following:
```
:::warning
This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
@@ -110,4 +115,4 @@ npm run build # Build the site for production
This will help you catch any issues before deploying
:::
---
---