From 29de9a1091325f981eb756bc25f07781c7c068b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=8E=9D=E2=8E=9D=EF=BC=B6=EF=BC=AF=EF=BC=B8=20=E2=8E=A0?= =?UTF-8?q?=E2=8E=A0?= Date: Sun, 6 Apr 2025 12:50:18 +0700 Subject: [PATCH] Update README.md The README.md was the default file for Docusaurus. So, I customized it. --- README.md | 46 ++++++++++++---------------------------------- 1 file changed, 12 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 5c6c376..db5dec1 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,19 @@ -# Website +# 👋 Open WebUI Documentation -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +Welcome to the official documentation for **Open WebUI** — a self-hosted, privacy-focused, and extensible AI interface for LLMs like Ollama and OpenAI-compatible APIs. -## Installation +This site is built with [Docusaurus](https://docusaurus.io/) and includes: -```sh -npm ci -``` +- 🔧 Installation & setup guides (Docker, local, manual) +- 🧩 Plugin & extension documentation +- 📚 API reference & pipeline usage +- 🗂 File uploads & RAG integration +- 🤖 Developer contribution guide -## Local Development +## 📝 Contributing -```sh -npm start -``` +Contributions are welcome! Please read the [contributing guide](docs/tutorials/tips/contributing-tutorial.md) for details. -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +## 🌐 Live Docs -## Build - -```sh -npm run build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -Using SSH: - -```sh -USE_SSH=true npm run deploy -``` - -Not using SSH: - -```sh -GIT_USER= npm run deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +👉 Visit the docs: [docs.openwebui.com](https://docs.openwebui.com/)