-
Notifications
You must be signed in to change notification settings - Fork 21
/
mkdocs.yml
142 lines (136 loc) · 3.64 KB
/
mkdocs.yml
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
61
62
63
64
65
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# Project information
site_name: RunGPT
# site_url: https://rungpt.dev.jina.ai
site_author: jina-ai GmbH
site_description: >-
Easily and cost-effectively LLM deployments on any cloud.
# Repository
repo_url: https://github.com/jina-ai/rungpt
repo_name: jina-ai/rungpt
edit_uri: edit/master/docs/
#Copyright
copyright: © 2023 jina-ai
# Configuration
theme:
name: material
custom_dir: docs/overrides
logo: assets/images/dstack-logo-notext.svg
favicon: assets/images/dstack-fav-32.ico
icon:
repo: custom/github
edit: material/pencil
font:
text: Poppins
code: IBM Plex Mono
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: lilac
# toggle:
# icon: material/weather-night
# name: Switch to dark mode
# - media: "(prefers-color-scheme: dark)"
# scheme: slate
# primary: black
# accent: light blue
# toggle:
# icon: material/weather-sunny
# name: Switch to light mode
features:
# - navigation.path
- content.code.copy
- content.action.edit
# - navigation.indexes
- navigation.tabs
# - navigation.instant
# - toc.integrate
- navigation.sections
# - navigation.expand
- navigation.top
- announce.dismiss
- navigation.tracking
- navigation.footer
# Plugins
plugins:
- search
- redirects:
redirect_maps:
'quickstart.md': 'docs/index.md'
'docs/quick-start.md': 'docs/index.md'
'docs/installation/index.md': 'docs/index.md'
# Extensions
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- attr_list
- def_list
- admonition
- pymdownx.highlight
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- toc:
toc_depth: 2
permalink: true
- attr_list
- md_in_html
- footnotes
# Customization
extra_css:
- assets/stylesheets/extra.css
- assets/stylesheets/termynal.css
- assets/stylesheets/landing.css
- assets/stylesheets/font.css
extra_javascript:
- assets/javascripts/extra.js
- assets/javascripts/termynal.js
extra:
homepage: /
generator: false
# analytics:
# provider: google
# property: G-XXXXXX
social:
- icon: /fontawesome/brands/github
link: https://github.com/jina-ai/rungpt
- icon: /fontawesome/brands/python
link: https://pypi.org/project/run-gpt-torch
# - icon: /fontawesome/brands/docker
# link: https://hub.docker.com/r/jina-ai/rungpt
- icon: /fontawesome/brands/discord
link: https://discord.gg/yaNVaaGSXZ
- icon: /fontawesome/brands/twitter
link: https://twitter.com/JinaAI_
status:
new: Recently added
# Page tree
nav:
- Home: index.md
- Docs:
- Getting started:
- Quick start: docs/index.md
- Guides:
- Projects: docs/guides/projects.md
- Deployment:
- Docker: docs/deployment/docker.md
- Kubernetes: docs/deployment/clouds.md
- Reference:
- CLI:
- rungpt serve: docs/reference/cli/start.md
- rungpt deploy: docs/reference/cli/start.md
- Examples: https://github.com/jina-ai/rungpt/blob/main/examples
- Discord: https://discord.gg/yaNVaaGSXZ
- Twitter: https://twitter.com/JinaAI_