Skip to content

Commit dfda4ff

Browse files
committed
add starlight documentation content
1 parent 18fde7c commit dfda4ff

48 files changed

Lines changed: 3868 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/astro.config.mjs

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
// @ts-check
2+
import { defineConfig } from 'astro/config';
3+
import starlight from '@astrojs/starlight';
4+
import { fileURLToPath } from 'node:url';
5+
import { ion } from 'starlight-ion-theme';
6+
import starlightGiscus from 'starlight-giscus';
7+
import starlightScrollToTop from 'starlight-scroll-to-top';
8+
import starlightLinksValidator from 'starlight-links-validator'
9+
import mermaid from 'astro-mermaid';
10+
11+
// https://astro.build/config
12+
export default defineConfig({
13+
integrations: [
14+
mermaid({
15+
theme: 'forest',
16+
autoTheme: true,
17+
iconPacks: [
18+
{
19+
name: 'logos',
20+
loader: () => fetch('https://unpkg.com/@iconify-json/logos@1/icons.json').then(res => res.json())
21+
},
22+
{
23+
name: 'lobe',
24+
loader: () => fetch('https://unpkg.com/@proj-airi/lobe-icons@latest/icons.json').then((res) => res.json()),
25+
},
26+
]
27+
}),
28+
starlight({
29+
title: 'OpenGateLLM',
30+
editLink: {
31+
baseUrl: 'https://github.com/etalab-ia/OpenGateLLM/edit/main/docs',
32+
},
33+
components: {
34+
Pagination: './src/components/Pagination.astro',
35+
},
36+
logo: {
37+
src: './src/assets/logo.svg',
38+
},
39+
social: [
40+
{
41+
icon: 'github',
42+
label: 'GitHub',
43+
href: 'https://github.com/etalab-ia/OpenGateLLM'
44+
}
45+
],
46+
plugins: [
47+
ion({
48+
icons: {
49+
iconDir: fileURLToPath(new URL('./src/assets/icons', import.meta.url)),
50+
include: { lucide: ['*'], lobe: ['*'] },
51+
},
52+
}),
53+
starlightGiscus({
54+
repo: 'etalab-ia/OpenGateLLM',
55+
repoId: 'R_kgDOMT6C-w',
56+
category: 'General',
57+
categoryId: 'DIC_kwDOMT6C-84CkkTP'
58+
}),
59+
starlightScrollToTop(),
60+
starlightLinksValidator(),
61+
],
62+
sidebar: [
63+
{
64+
label: 'Overview',
65+
autogenerate: {
66+
directory: 'overview',
67+
},
68+
},
69+
{
70+
label: '[lucide:mountain]Roadmap',
71+
link: 'https://github.com/etalab-ia/OpenGateLLM/milestone/4',
72+
attrs: { target: '_blank', style: 'font-size: 0.875rem;' },
73+
},
74+
{
75+
label: '[lucide:book-open] API reference',
76+
link: '/reference/',
77+
attrs: { target: '_blank', style: 'font-size: 0.875rem;' },
78+
}, {
79+
label: '[lucide:rocket] Release notes',
80+
link: 'https://github.com/etalab-ia/OpenGateLLM/releases',
81+
badge: 'v0.4.0post1',
82+
attrs: { target: '_blank', style: 'font-size: 0.875rem;' },
83+
},
84+
{
85+
label: 'Getting started',
86+
autogenerate: {
87+
directory: 'getting-started',
88+
},
89+
},
90+
{
91+
label: 'Advanced configuration',
92+
autogenerate: {
93+
directory: 'configuration',
94+
},
95+
},
96+
{
97+
label: 'Deployment',
98+
autogenerate: {
99+
directory: 'deployment',
100+
},
101+
},
102+
{
103+
label: 'Features',
104+
autogenerate: {
105+
directory: 'features',
106+
},
107+
},
108+
{
109+
label: 'Contributing',
110+
items: [
111+
{ label: '[lucide:book-open] Contributing guide', autogenerate: { directory: 'contributing' } },
112+
],
113+
},
114+
],
115+
}),
116+
],
117+
});

docs/package.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"name": "starry-spiral",
3+
"type": "module",
4+
"version": "0.0.1",
5+
"scripts": {
6+
"dev": "astro dev",
7+
"start": "astro dev",
8+
"build": "astro build",
9+
"preview": "astro preview",
10+
"astro": "astro"
11+
},
12+
"dependencies": {
13+
"@astrojs/starlight": "^0.35.3",
14+
"@iconify-json/lobe": "npm:@proj-airi/lobe-icons@^1.0.18",
15+
"@iconify-json/lucide": "^1.2.90",
16+
"@lobehub/icons": "^4.6.0",
17+
"@mermaid-js/layout-elk": "^0.2.0",
18+
"astro": "^5.17.2",
19+
"astro-mermaid": "^1.3.1",
20+
"mermaid": "^11.12.3",
21+
"sharp": "^0.34.2",
22+
"starlight-contributor-list": "^0.3.2",
23+
"starlight-giscus": "^0.8.1",
24+
"starlight-ion-theme": "^2.3.3",
25+
"starlight-links-validator": "^0.19.2",
26+
"starlight-scroll-to-top": "^0.4.0"
27+
}
28+
}

docs/public/favicon.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/redoc-static.html

Lines changed: 1278 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 5 additions & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

docs/src/assets/icons/postgres.svg

Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)