github-starred/ollama
2
0
Fork 0
mirror of https://github.com/ollama/ollama.git synced 2026-05-06 16:11:34 -05:00
Code Issues 14.5k Packages Projects Releases 120 Wiki Activity

[PR #9927] [CLOSED] Implement documentation site #44345

New Issue
Closed
opened 2026-04-24 23:50:59 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-24 23:50:59 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/ollama/ollama/pull/9927
Author: @ghost
Created: 3/21/2025
Status: ❌ Closed

Base: main ← Head: implement-doc-site

📝 Commits (2)

  • 64f8f71 Implement documentation site
  • 372ad23 Customization for ollama team

📊 Changes

12 files changed (+326 additions, -2 deletions)

View changed files

➕ .github/workflows/docs-production-deploy.yaml (+26 -0)
➕ .github/workflows/scripts/docs/build-docs.sh (+18 -0)
📝 docs/README.md (+4 -1)
➕ docs/assets/css/customizations.css (+143 -0)
➕ docs/assets/fonts/external-link.woff (+0 -0)
➕ docs/assets/logo/favicon.ico (+0 -0)
➕ docs/assets/logo/ollama.png (+0 -0)
📝 docs/examples.md (+2 -1)
➕ docs/overrides/404.html (+1 -0)
➕ docs/overrides/assets/img/bg-water.webp (+0 -0)
➕ docs/overrides/favicon.ico (+0 -0)
➕ mkdocs.yml (+132 -0)

📄 Description

Tip

I love Ollama because it helps me a lot. This work is done solely for the purpose of loving this project.

With the minimum alteration of the original docs, this PR implements a mkdocs-based documentation site. The documentation contents are the original docs. Here is what it looks like on live

Note

  • This PR configures documentation to be deployed to docs.ollama.com. If docs.ollama.com is not available at this moment, I can simply make it use default GitHub pages URL so that no external CNAME is required

This PR brings several advantages to Ollama, including:

  1. A very successful project like Ollama deserves a dedicated documentation site, like all other great Open Source softwares do.
  2. Exposing documentation in a modern UI puts ollama team in a much better position on offering excellent user experiences
  3. The new site offers indexing which allows users to quickly search for what they are looking for:
    page 2

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/ollama/ollama/pull/9927 **Author:** [@ghost](https://github.com/ghost) **Created:** 3/21/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `implement-doc-site` --- ### 📝 Commits (2) - [`64f8f71`](https://github.com/ollama/ollama/commit/64f8f71383469737b75a1b22596ca9295b997d0f) Implement documentation site - [`372ad23`](https://github.com/ollama/ollama/commit/372ad23d69d85dc4c9d683e9b98d886c12b17480) Customization for ollama team ### 📊 Changes **12 files changed** (+326 additions, -2 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/docs-production-deploy.yaml` (+26 -0) ➕ `.github/workflows/scripts/docs/build-docs.sh` (+18 -0) 📝 `docs/README.md` (+4 -1) ➕ `docs/assets/css/customizations.css` (+143 -0) ➕ `docs/assets/fonts/external-link.woff` (+0 -0) ➕ `docs/assets/logo/favicon.ico` (+0 -0) ➕ `docs/assets/logo/ollama.png` (+0 -0) 📝 `docs/examples.md` (+2 -1) ➕ `docs/overrides/404.html` (+1 -0) ➕ `docs/overrides/assets/img/bg-water.webp` (+0 -0) ➕ `docs/overrides/favicon.ico` (+0 -0) ➕ `mkdocs.yml` (+132 -0) </details> ### 📄 Description > [!TIP] > > I love Ollama because it helps me a lot. This work is done solely for the purpose of loving this project. With the minimum alteration of the [original docs](https://github.com/ollama/ollama/tree/main/docs), __this PR implements a mkdocs-based documentation site__. The documentation contents are the original docs. [Here is what it looks like on live](https://ollama.qubitpi.org/) > [!NOTE] > > - This PR configures documentation to be deployed to __docs.ollama.com__. If __docs.ollama.com__ is not available at this moment, I can simply make it use default GitHub pages URL so that no external CNAME is required This PR brings several advantages to Ollama, including: 1. A very successful project like Ollama deserves a dedicated documentation site, like all other great Open Source softwares do. 2. Exposing documentation in a modern UI puts ollama team in a much better position on offering excellent user experiences 3. The new site offers indexing which allows users to quickly search for what they are looking for: ![page 2](https://github.com/user-attachments/assets/38b1ee57-5e28-4974-be08-5aa2d6a745a7) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-24 23:50:59 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
amd
api
app
bug
build
cli
cloud
compatibility
context-length
create
docker
documentation
embeddings
feature request
feedback wanted
good first issue
gpt-oss
gpu
harmony
help wanted
image
install
intel
js
launch
linux
macos
memory
mlx
model
needs more info
networking
nvidia
ollama.com
performance
pull-request
Mirrored from GitHub Pull Request
 python
question
registry
rendering
thinking
tools
top
vulkan
windows
wsl
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/ollama#44345
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?