Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
docs.json 3.59 KB
Newer Older
Parth Sareen's avatar
docs: add docs for docs.ollama.com (#12805)  
Parth Sareen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60 
{
  "$schema": "https://mintlify.com/docs.json",
  "name": "Ollama",
  "colors": {
    "primary": "#000",
    "light": "#b5b5b5",
    "dark": "#000"
  },
  "favicon": "/images/favicon.png",
  "logo": {
    "light": "/images/logo.png",
    "dark": "/images/logo-dark.png",
    "href": "https://ollama.com"
  },
  "theme": "maple",
  "background": {
    "color": {
      "light": "#ffffff",
      "dark": "#000000"
    }
  },
  "fonts": {
    "family": "system-ui",
    "heading": {
      "family": "system-ui"
    },
    "body": {
      "family": "system-ui"
    }
  },
  "styling": {
    "codeblocks": "system"
  },
  "contextual": {
    "options": ["copy"]
  },
  "navbar": {
    "links": [
      {
        "label": "Sign in",
        "href": "https://ollama.com/signin"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Download",
      "href": "https://ollama.com/download"
    }
  },
  "api": {
    "playground": {
      "display": "simple"
    },
    "examples": {
      "languages": ["curl"]
    }
  },
  "redirects": [
    {
      "source": "/openai",
Jeffrey Morgan's avatar
docs: temporarily restore api.md and cleanup docs paths (#12818)  
Jeffrey Morgan committed
61 
      "destination": "/api/openai-compatibility"
Jeffrey Morgan's avatar
docs: add new cloud model + fix openai redirect (#12812)  
Jeffrey Morgan committed
62
63
64
65 
    },
    {
      "source": "/api/openai",
      "destination": "/api/openai-compatibility"
Parth Sareen's avatar
docs: add docs for docs.ollama.com (#12805)  
Parth Sareen committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114 
    }
  ],
  "navigation": {
    "tabs": [
      {
        "tab": "Documentation",
        "groups": [
          {
            "group": "Get started",
            "pages": [
              "index",
              "quickstart",
              "/cloud"
            ]
          },
          {
            "group": "Capabilities",
            "pages": [
              "/capabilities/streaming",
              "/capabilities/thinking",
              "/capabilities/structured-outputs",
              "/capabilities/vision",
              "/capabilities/embeddings",
              "/capabilities/tool-calling",
              "/capabilities/web-search"
            ]
          },
          {
            "group": "Integrations",
            "pages": [
              "/integrations/vscode",
              "/integrations/jetbrains",
              "/integrations/codex",
              "/integrations/cline",
              "/integrations/droid",
              "/integrations/goose",
              "/integrations/zed",
              "/integrations/roo-code",
              "/integrations/n8n",
              "/integrations/xcode"
            ]
          },
          {
            "group": "More information",
            "pages": [
              "/cli",
              "/modelfile",
              "/context-length",
              "/linux",
Parth Sareen's avatar
docs: update readme and links (#12809)  
Parth Sareen committed
115
116 
              "/macos",
              "/windows",
Parth Sareen's avatar
docs: add docs for docs.ollama.com (#12805)  
Parth Sareen committed
117 
              "/docker",
Parth Sareen's avatar
docs: update readme and links (#12809)  
Parth Sareen committed
118 
              "/import",
Parth Sareen's avatar
docs: add docs for docs.ollama.com (#12805)  
Parth Sareen committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132 
              "/faq",
              "/gpu",
              "/troubleshooting"
            ]
          }
        ]
      },
      {
        "tab": "API Reference",
        "openapi": "/openapi.yaml",
        "groups": [
          {
            "group": "API Reference",
            "pages": [
Jeffrey Morgan's avatar
docs: temporarily restore api.md and cleanup docs paths (#12818)  
Jeffrey Morgan committed
133 
              "/api/index",
Parth Sareen's avatar
docs: add docs for docs.ollama.com (#12805)  
Parth Sareen committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162 
              "/api/authentication",
              "/api/streaming",
              "/api/usage",
              "/api/errors",
              "/api/openai-compatibility"
            ]
          },
          {
            "group": "Endpoints",
            "pages": [
              "POST /api/generate",
              "POST /api/chat",
              "POST /api/embed",
              "GET /api/tags",
              "GET /api/ps",
              "POST /api/show",
              "POST /api/create",
              "POST /api/copy",
              "POST /api/pull",
              "POST /api/push",
              "DELETE /api/delete",
              "GET /api/version"
            ]
          }
        ]
      }
    ]
  }
}