docs: revert changes to docusaurus and ghpages

This commit is contained in:
Matthew Hand 2024-11-05 22:59:29 +00:00
parent b787483aba
commit 306d16515d
2 changed files with 224 additions and 57 deletions

View File

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

170
docusaurus.config.ts Normal file
View File

@ -0,0 +1,170 @@
import { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import { themes as prismThemes } from "prism-react-renderer";
const config: Config = {
title: "Open WebUI",
tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
favicon: "img/favicon.png",
// Set the production url of your site here
url: "https://openwebui.com",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",
// 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: "docs", // Usually your repo name.
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en"],
},
// Enable Mermaid for diagrams
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
presets: [
[
"classic",
{
docs: {
sidebarPath: "./sidebars.ts",
routeBasePath: "/",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/open-webui/docs/blob/main",
exclude: ["**/tab-**/**"],
},
// blog: false,
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// editUrl:
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
},
theme: {
customCss: "./src/css/custom.css",
},
} satisfies Preset.Options,
],
],
themeConfig: {
// Replace with your project's social card
// image: "img/docusaurus-social-card.jpg",
navbar: {
title: "Open WebUI",
logo: {
src: "img/logo.png",
srcDark: "img/logo-dark.png",
},
items: [
// {
// type: "docSidebar",
// position: "left",
// sidebarId: "pipelines",
// label: "Pipelines",
// },
// {
// type: "docSidebar",
// sidebarId: "blog",
// position: "left",
// label: "Blog",
// },
// {
// href: "/blog",
// label: "Blog",
// position: "left",
// },
{
href: "https://github.com/open-webui/open-webui",
position: "right",
className: "header-github-link",
"aria-label": "GitHub repository",
},
{
href: "https://discord.com/invite/5rJgQTnV4s",
position: "right",
className: "header-discord-link",
"aria-label": "Discord server",
},
],
},
footer: {
logo: {
src: "img/logo-dark.png",
height: 100,
},
style: "light",
links: [
{
title: "Docs",
items: [
{
label: "Getting Started",
to: "getting-started",
},
{
label: "FAQ",
to: "faq",
},
],
},
{
title: "Community",
items: [
{
label: "GitHub",
href: "https://github.com/open-webui/open-webui",
},
{
label: "Discord",
href: "https://discord.gg/5rJgQTnV4s",
},
{
label: "𝕏",
href: "https://x.com/OpenWebUI",
},
],
},
{
title: "More",
items: [
{
label: "Release Notes",
to: "https://github.com/open-webui/open-webui/blob/main/CHANGELOG.md",
},
{
label: "About",
to: "https://openwebui.com",
},
],
},
],
// copyright: `Copyright © ${new Date().getFullYear()} OpenWebUI`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
plugins: [require.resolve("docusaurus-lunr-search")],
};
export default config;