tangled
alpha
login
or
join now
stream.place
/
streamplace
74
fork
atom
Live video on the AT Protocol
74
fork
atom
overview
issues
1
pulls
pipelines
disable validator for now
Natalie B.
2 months ago
45ffe1de
1905a003
+76
-48
2 changed files
expand all
collapse all
unified
split
js
docs
astro.config.mjs
src
content
docs
reference.mdx
+67
-48
js/docs/astro.config.mjs
···
1
1
// @ts-check
2
2
import starlight from "@astrojs/starlight";
3
3
import { defineConfig, passthroughImageService } from "astro/config";
4
4
-
import starlightLinksValidator from "starlight-links-validator";
5
4
import starlightOpenAPI, { openAPISidebarGroups } from "starlight-openapi";
6
5
import starlightSidebarSwipe from "starlight-sidebar-swipe";
7
6
import starlightSidebarTopics from "starlight-sidebar-topics";
···
35
34
},
36
35
favicon: "/favicon.ico",
37
36
plugins: [
38
38
-
starlightLinksValidator(),
37
37
+
//starlightLinksValidator(),
39
38
starlightSidebarSwipe(),
40
40
-
starlightSidebarTopics([
41
41
-
{
42
42
-
label: "For Streamers & Viewers",
43
43
-
link: "/",
44
44
-
icon: "open-book",
45
45
-
items: [
46
46
-
{
47
47
-
label: "Start Streaming",
48
48
-
autogenerate: { directory: "guides/start-streaming" },
49
49
-
},
50
50
-
{
51
51
-
label: "Features",
52
52
-
autogenerate: { directory: "features" },
53
53
-
},
54
54
-
],
55
55
-
},
56
56
-
{
57
57
-
label: "For Developers",
58
58
-
link: "/developers/",
59
59
-
icon: "seti:config",
60
60
-
items: [
61
61
-
{
62
62
-
label: "Start Contributing",
63
63
-
autogenerate: { directory: "guides/start-contributing" },
64
64
-
},
65
65
-
{
66
66
-
label: "Installing Streamplace",
67
67
-
autogenerate: { directory: "guides/installing" },
68
68
-
},
69
69
-
{
70
70
-
label: "Video Metadata",
71
71
-
autogenerate: { directory: "video-metadata" },
72
72
-
},
73
73
-
{
74
74
-
label: "Components",
75
75
-
autogenerate: { directory: "components" },
76
76
-
},
77
77
-
{
78
78
-
label: "Lexicon Reference",
79
79
-
autogenerate: { directory: "lex-reference" },
80
80
-
},
81
81
-
...openAPISidebarGroups,
82
82
-
],
83
83
-
},
84
84
-
]),
85
39
starlightOpenAPI([
86
40
{
87
87
-
base: "api",
41
41
+
base: "/api",
88
42
label: "Related XRPC API endpoints",
89
43
schema: "./src/content/docs/lex-reference/openapi.json", // or your json generated from swagger
90
44
sidebar: {
···
95
49
},
96
50
},
97
51
]),
52
52
+
starlightSidebarTopics(
53
53
+
[
54
54
+
{
55
55
+
label: "For Streamers & Viewers",
56
56
+
link: "/",
57
57
+
icon: "open-book",
58
58
+
items: [
59
59
+
{
60
60
+
label: "Start Streaming",
61
61
+
autogenerate: { directory: "guides/start-streaming" },
62
62
+
},
63
63
+
{
64
64
+
label: "Features",
65
65
+
autogenerate: { directory: "features" },
66
66
+
},
67
67
+
],
68
68
+
},
69
69
+
{
70
70
+
label: "For Developers",
71
71
+
link: "/developers/",
72
72
+
icon: "seti:config",
73
73
+
id: "developers",
74
74
+
items: [
75
75
+
{
76
76
+
label: "Start Contributing",
77
77
+
autogenerate: { directory: "guides/start-contributing" },
78
78
+
},
79
79
+
{
80
80
+
label: "Installing Streamplace",
81
81
+
autogenerate: { directory: "guides/installing" },
82
82
+
},
83
83
+
{
84
84
+
label: "Video Metadata",
85
85
+
autogenerate: { directory: "video-metadata" },
86
86
+
},
87
87
+
{
88
88
+
label: "Components",
89
89
+
autogenerate: { directory: "components" },
90
90
+
},
91
91
+
{
92
92
+
label: "Localize Streamplace",
93
93
+
autogenerate: { directory: "guides/localizing" },
94
94
+
},
95
95
+
],
96
96
+
},
97
97
+
{
98
98
+
label: "API Reference",
99
99
+
link: "/reference/",
100
100
+
icon: "seti:json",
101
101
+
id: "ref",
102
102
+
items: [
103
103
+
{
104
104
+
label: "Lexicon Reference",
105
105
+
autogenerate: { directory: "lex-reference" },
106
106
+
},
107
107
+
...openAPISidebarGroups,
108
108
+
],
109
109
+
},
110
110
+
],
111
111
+
{
112
112
+
topics: {
113
113
+
ref: ["/api", "/api/**/*"],
114
114
+
},
115
115
+
},
116
116
+
),
98
117
],
99
118
}),
100
119
],
+9
js/docs/src/content/docs/reference.mdx
···
1
1
+
---
2
2
+
title: API Reference
3
3
+
description: Our XRPC and OpenAPI Reference documentation
4
4
+
template: doc
5
5
+
---
6
6
+
7
7
+
import { Card, CardGrid } from "@astrojs/starlight/components";
8
8
+
9
9
+
Here contains our XRPC and OpenAPI Reference documentation.