Skip to content

Commit 014e3d6

Browse files
committed
docs: move to SolidBase
1 parent fc3d73a commit 014e3d6

33 files changed

Lines changed: 3471 additions & 3086 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: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
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+
prerender: {
15+
crawlLinks: true,
16+
},
17+
},
18+
},
19+
{
20+
title: "Solid Relay",
21+
description: "SolidJS Bindings for Relay",
22+
lang: "en",
23+
issueAutolink: "https://github.com/XiNiHa/solid-relay/issues/:issue",
24+
editPath: "https://github.com/XiNiHa/solid-relay/edit/main/docs/:path",
25+
themeConfig: {
26+
socialLinks: {
27+
// @ts-ignore
28+
github: "https://github.com/XiNiHa/solid-relay",
29+
},
30+
nav: [
31+
{
32+
text: "Guide",
33+
link: "/guide",
34+
},
35+
{
36+
text: "API",
37+
link: "/api",
38+
},
39+
],
40+
sidebar: {
41+
"/guide": {
42+
items: [
43+
{
44+
title: "Overview",
45+
collapsed: false,
46+
items: [
47+
{
48+
title: "Getting Started",
49+
link: "/",
50+
},
51+
],
52+
},
53+
],
54+
},
55+
"/api": {
56+
items: [
57+
{
58+
title: "API Reference",
59+
collapsed: false,
60+
items: [
61+
{
62+
title: "Index",
63+
link: "/",
64+
},
65+
],
66+
},
67+
...(await Promise.all(
68+
["Functions", "Interfaces"].map(
69+
async (section): Promise<SidebarItem> => {
70+
const dir = section.toLowerCase();
71+
const items = await fs.promises.readdir(
72+
path.join(import.meta.dirname, "src/routes/api", dir),
73+
);
74+
75+
return {
76+
title: section,
77+
collapsed: false,
78+
items: items.map((item) => {
79+
const name = path
80+
.basename(item)
81+
.replace(path.extname(item), "");
82+
return {
83+
title: name,
84+
link: `/${dir}/${name}`,
85+
};
86+
}),
87+
};
88+
},
89+
),
90+
)),
91+
],
92+
},
93+
},
94+
},
95+
},
96+
),
97+
);

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/mise.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[tools]
2+
node = "20.13.0"

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.43.10"
11+
"@fontsource-variable/inter": "^5.2.5",
12+
"@fontsource-variable/jetbrains-mono": "^5.2.5",
13+
"@fontsource-variable/lexend": "^5.2.6",
14+
"@kobalte/solidbase": "^0.2.2",
15+
"@solidjs/meta": "^0.29.4",
16+
"@solidjs/router": "^0.15.3",
17+
"@solidjs/start": "^1.1.3",
18+
"@vinxi/plugin-mdx": "^3.7.2",
19+
"solid-js": "^1.9.5",
20+
"solid-mdx": "^0.0.7",
21+
"vinxi": "^0.5.3"
1122
},
1223
"devDependencies": {
13-
"@rspress/plugin-typedoc": "^1.43.10",
24+
"@iconify-json/ri": "^1.2.5",
1425
"@types/node": "^22.14.0",
15-
"solid-relay": "workspace:^"
26+
"solid-relay": "workspace:^",
27+
"typedoc": "^0.28.2",
28+
"typedoc-plugin-markdown": "^4.6.1"
1629
}
1730
}

docs/public/favicon.ico

Whitespace-only changes.

docs/rspress.config.ts

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

0 commit comments

Comments
 (0)