Skip to content

Commit 6519107

Browse files
committed
docs: move to SolidBase
1 parent 76f4873 commit 6519107

32 files changed

Lines changed: 3076 additions & 2450 deletions

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
node_modules
88
dist/
99
doc_build/
10+
.vinxi/
11+
.output/
1012

1113
# IDE
1214
.vscode/*

docs/README.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/app.config.ts

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
import * as fs from "node:fs";
2+
import * as path from "node:path";
3+
import { createWithSolidBase } from "@kobalte/solidbase/config";
4+
import defaultTheme, {
5+
type SidebarItem,
6+
} from "@kobalte/solidbase/default-theme";
7+
import { defineConfig } from "@solidjs/start/config";
8+
9+
export default defineConfig(
10+
createWithSolidBase(defaultTheme)(
11+
{
12+
ssr: true,
13+
server: {
14+
compatibilityDate: "2025-05-26",
15+
preset: "cloudflare_module",
16+
cloudflare: {
17+
deployConfig: true,
18+
nodeCompat: true,
19+
},
20+
prerender: {
21+
crawlLinks: true,
22+
},
23+
},
24+
},
25+
{
26+
title: "Solid Relay",
27+
description: "SolidJS Bindings for Relay",
28+
lang: "en",
29+
issueAutolink: "https://github.com/XiNiHa/solid-relay/issues/:issue",
30+
editPath: "https://github.com/XiNiHa/solid-relay/edit/main/docs/:path",
31+
themeConfig: {
32+
socialLinks: {
33+
// @ts-ignore
34+
github: "https://github.com/XiNiHa/solid-relay",
35+
},
36+
nav: [
37+
{
38+
text: "Guide",
39+
link: "/guide",
40+
},
41+
{
42+
text: "API",
43+
link: "/api",
44+
},
45+
],
46+
sidebar: {
47+
"/guide": {
48+
items: [
49+
{
50+
title: "Overview",
51+
collapsed: false,
52+
items: [
53+
{
54+
title: "Getting Started",
55+
link: "/",
56+
},
57+
],
58+
},
59+
],
60+
},
61+
"/api": {
62+
items: [
63+
{
64+
title: "API Reference",
65+
collapsed: false,
66+
items: [
67+
{
68+
title: "Index",
69+
link: "/",
70+
},
71+
],
72+
},
73+
...(await Promise.all(
74+
["Functions", "Interfaces"].map(
75+
async (section): Promise<SidebarItem> => {
76+
const dir = section.toLowerCase();
77+
const items = await fs.promises.readdir(
78+
path.join(import.meta.dirname, "src/routes/api", dir),
79+
);
80+
81+
return {
82+
title: section,
83+
collapsed: false,
84+
items: items.map((item) => {
85+
const name = path
86+
.basename(item)
87+
.replace(path.extname(item), "");
88+
return {
89+
title: name,
90+
link: `/${dir}/${name}`,
91+
};
92+
}),
93+
};
94+
},
95+
),
96+
)),
97+
],
98+
},
99+
},
100+
},
101+
},
102+
),
103+
);

docs/docs/_meta.json

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/docs/guide/_meta.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/docs/public/favicon.png

-319 Bytes
Binary file not shown.

docs/package.json

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
11
{
22
"name": "solid-relay-docs",
3+
"type": "module",
34
"private": true,
45
"scripts": {
5-
"dev": "rspress dev",
6-
"build": "rspress build",
7-
"preview": "rspress preview"
6+
"dev": "vinxi dev",
7+
"build": "typedoc && vinxi build",
8+
"preview": "vinxi preview"
89
},
910
"dependencies": {
10-
"rspress": "^1.44.0"
11+
"@fontsource-variable/inter": "^5.2.5",
12+
"@fontsource-variable/jetbrains-mono": "^5.2.5",
13+
"@fontsource-variable/lexend": "^5.2.7",
14+
"@kobalte/solidbase": "^0.2.11",
15+
"@solidjs/meta": "^0.29.4",
16+
"@solidjs/router": "^0.15.3",
17+
"@solidjs/start": "^1.1.4",
18+
"@vinxi/plugin-mdx": "^3.7.2",
19+
"solid-js": "^1.9.7",
20+
"solid-mdx": "^0.0.7",
21+
"vinxi": "^0.5.6"
1122
},
1223
"devDependencies": {
13-
"@rspress/plugin-typedoc": "^1.44.0",
24+
"@iconify-json/ri": "^1.2.5",
1425
"@types/node": "^22.15.21",
15-
"solid-relay": "workspace:^"
26+
"solid-relay": "workspace:^",
27+
"typedoc": "^0.28.4",
28+
"typedoc-plugin-markdown": "^4.6.3"
1629
}
1730
}

docs/public/favicon.ico

Whitespace-only changes.

docs/rspress.config.ts

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/src/app.tsx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { SolidBaseRoot } from "@kobalte/solidbase/client";
2+
import { Router } from "@solidjs/router";
3+
import { FileRoutes } from "@solidjs/start/router";
4+
5+
export default function App() {
6+
return (
7+
<Router root={SolidBaseRoot}>
8+
<FileRoutes />
9+
</Router>
10+
);
11+
}

0 commit comments

Comments
 (0)