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

[PR #8854] [MERGED] docs: add syntax highlighting in code blocks #12795

New Issue
Closed
opened 2026-04-13 00:09:53 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-13 00:09:53 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/ollama/ollama/pull/8854
Author: @fyvri
Created: 2/5/2025
Status: ✅ Merged
Merged: 2/7/2025
Merged by: @jmorganca

Base: main ← Head: docs/code-blocks

📝 Commits (10+)

  • 7da1207 docs: add syntax highlighting in code blocks
  • 8260c56 docs: correct OLLAMA_VERSION in installation guide
  • 60ca405 style(docs): improve code block formatting
  • 9432158 Merge branch 'ollama:main' into docs/code-blocks
  • cbeb972 Merge branch 'ollama:main' into docs/code-blocks
  • d50503f Merge branch 'ollama:main' into docs/code-blocks
  • 6546e2a Merge branch 'main' into docs/code-blocks
  • 482d24d style(docs): clarify Modelfile syntax in code blocks
  • cbfaf03 style(docs): minor formatting and wording improvements
  • 5a5bed0 docs(openai): refine note style

📊 Changes

16 files changed (+158 additions, -127 deletions)

View changed files

📝 README.md (+23 -21)
📝 api/examples/README.md (+2 -1)
📝 app/README.md (+1 -1)
📝 docs/api.md (+17 -16)
📝 docs/development.md (+10 -10)
📝 docs/docker.md (+27 -23)
📝 docs/faq.md (+14 -4)
📝 docs/import.md (+2 -2)
📝 docs/linux.md (+1 -1)
📝 docs/modelfile.md (+35 -29)
📝 docs/openai.md (+8 -5)
📝 docs/troubleshooting.md (+7 -4)
📝 docs/windows.md (+1 -0)
📝 llama/README.md (+5 -5)
📝 llama/runner/README.md (+3 -3)
📝 macapp/README.md (+2 -2)

📄 Description

📖 Summary

This pull request includes several documentation improvements aimed at enhancing readability, accuracy, and overall user experience. The changes focus on refining code blocks and ensuring the installation guide is up-to-date.

🛠️ Changes

  1. Add syntax highlighting in code blocks
    • Updated the documentation to include syntax highlighting in code blocks. This improves readability and makes it easier for users to understand the code examples.
    • Refined the formatting of code blocks throughout the documentation. These stylistic adjustments contribute to a more consistent and professional appearance.
  2. Correct OLLAMA_VERSION in installation guide
    • Fixed an outdated or incorrect reference to OLLAMA_VERSION in the installation guide. This ensures users are provided with accurate information when setting up the project.

🚀 Impact

  • Syntax highlighting helps users quickly identify syntax elements, reducing cognitive load and improving comprehension.
  • Improved formatting enhances the overall quality of the documentation, making it more approachable and user-friendly.
  • Correcting the OLLAMA_VERSION ensures that users follow the proper installation steps, avoiding potential issues during setup.

Let me know if there are any questions or further clarifications needed 🙌

🔄 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/8854 **Author:** [@fyvri](https://github.com/fyvri) **Created:** 2/5/2025 **Status:** ✅ Merged **Merged:** 2/7/2025 **Merged by:** [@jmorganca](https://github.com/jmorganca) **Base:** `main` ← **Head:** `docs/code-blocks` --- ### 📝 Commits (10+) - [`7da1207`](https://github.com/ollama/ollama/commit/7da12074772302a1e36004eb00c3ea2288e0a3e4) docs: add syntax highlighting in code blocks - [`8260c56`](https://github.com/ollama/ollama/commit/8260c5663ffe58dbd6dd5174ae11fd2b89232a57) docs: correct OLLAMA_VERSION in installation guide - [`60ca405`](https://github.com/ollama/ollama/commit/60ca405fe66b074705ec37e7f5ce5af64a6ba2f9) style(docs): improve code block formatting - [`9432158`](https://github.com/ollama/ollama/commit/943215843cb7a7e0cc797b835afaf950a6f1cc33) Merge branch 'ollama:main' into docs/code-blocks - [`cbeb972`](https://github.com/ollama/ollama/commit/cbeb972dd1c0cc91530791c708485c3282c60ff8) Merge branch 'ollama:main' into docs/code-blocks - [`d50503f`](https://github.com/ollama/ollama/commit/d50503fd6bedf66a6a5063de51aede226467d1f2) Merge branch 'ollama:main' into docs/code-blocks - [`6546e2a`](https://github.com/ollama/ollama/commit/6546e2a479c65e61babb5f0f197a52219d39c6f1) Merge branch 'main' into docs/code-blocks - [`482d24d`](https://github.com/ollama/ollama/commit/482d24dbc2133297b10fa1f2e9294d88c754493e) style(docs): clarify Modelfile syntax in code blocks - [`cbfaf03`](https://github.com/ollama/ollama/commit/cbfaf0305ff27ec31b1f3e11f8b7501ad8f413d8) style(docs): minor formatting and wording improvements - [`5a5bed0`](https://github.com/ollama/ollama/commit/5a5bed0356f8a62e178f35a37c62099e3d55801b) docs(openai): refine note style ### 📊 Changes **16 files changed** (+158 additions, -127 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+23 -21) 📝 `api/examples/README.md` (+2 -1) 📝 `app/README.md` (+1 -1) 📝 `docs/api.md` (+17 -16) 📝 `docs/development.md` (+10 -10) 📝 `docs/docker.md` (+27 -23) 📝 `docs/faq.md` (+14 -4) 📝 `docs/import.md` (+2 -2) 📝 `docs/linux.md` (+1 -1) 📝 `docs/modelfile.md` (+35 -29) 📝 `docs/openai.md` (+8 -5) 📝 `docs/troubleshooting.md` (+7 -4) 📝 `docs/windows.md` (+1 -0) 📝 `llama/README.md` (+5 -5) 📝 `llama/runner/README.md` (+3 -3) 📝 `macapp/README.md` (+2 -2) </details> ### 📄 Description ### 📖 Summary This pull request includes several documentation improvements aimed at enhancing readability, accuracy, and overall user experience. The changes focus on refining code blocks and ensuring the installation guide is up-to-date. ### 🛠️ Changes 1. **Add syntax highlighting in code blocks** - Updated the documentation to include syntax highlighting in code blocks. This improves readability and makes it easier for users to understand the code examples. - Refined the formatting of code blocks throughout the documentation. These stylistic adjustments contribute to a more consistent and professional appearance. 2. **Correct `OLLAMA_VERSION` in installation guide** - Fixed an outdated or incorrect reference to `OLLAMA_VERSION` in the installation guide. This ensures users are provided with accurate information when setting up the project. ### 🚀 Impact - **Syntax highlighting** helps users quickly identify syntax elements, reducing cognitive load and improving comprehension. - Improved formatting enhances the overall quality of the documentation, making it more approachable and user-friendly. - Correcting the `OLLAMA_VERSION` ensures that users follow the proper installation steps, avoiding potential issues during setup. --- Let me know if there are any questions or further clarifications needed 🙌 --- <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-13 00:09:53 -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#12795
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?