feat: gh-pages added

This commit is contained in:
Timothy J. Baek 2024-02-19 21:33:28 -08:00
parent 25eb3e3341
commit a41abbb409
3 changed files with 60 additions and 2 deletions

54
.github/workflows/gh-pages.yml vendored Normal file
View File

@ -0,0 +1,54 @@
name: Deploy site to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: npm
- name: Install dependencies
run: npm ci
- name: Build
run: npm run build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./build
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

4
docs/getting-started.md Normal file
View File

@ -0,0 +1,4 @@
---
sidebar_position: 2
title: "🔑 Getting Started"
---

View File

@ -20,8 +20,8 @@ const config = {
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
// organizationName: "open-webui", // Usually your GitHub org/user name.
// projectName: "open-webui", // Usually your repo name.
organizationName: "open-webui", // Usually your GitHub org/user name.
projectName: "docs", // Usually your repo name.
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",