Skip to content

Commit 9eff5bb

Browse files
committed
docs: Add new docs
1 parent 8184bed commit 9eff5bb

27 files changed

+1969
-3
lines changed

.vscode/extensions.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
22
"recommendations": [
33
// Rust Language Server (rust-analyzer)
4-
"rust-lang.rust-analyzer"
4+
"rust-lang.rust-analyzer",
5+
// Deno Language Server (only website)
6+
"denoland.vscode-deno"
57
]
68
}

.vscode/settings.json

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"rust-analyzer.linkedProjects": [
33
"./Cargo.toml"
44
],
5+
"deno.enablePaths": ["./website"],
56
"rust-analyzer.restartServerOnConfigChange": true,
67
"editor.defaultFormatter": "rust-lang.rust-analyzer",
78
"editor.formatOnSave": true,

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ docker pull ghcr.io/m1sk9/babyrite:v0
1616

1717
[*API Support: requires Discord API v10*](https://discord.com/developers/docs/reference#api-versioning)
1818

19-
![Execution](./docs/src/public/example.gif)
19+
![Execution](./website/example.gif)
2020

2121
## Setup and Hosting
2222

2323
babyrite can be hosted using Docker Compose or k8s.
2424

25-
See [official guide](https://babyrite.m1sk9.dev/installation.html) for setup and hosting.
25+
See [official guide](https://babyrite.m1sk9.dev/guide/hosting.html) for setup and hosting.
2626

2727
## Details
2828

website/.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.vitepress/cache/
2+
.vitepress/dist/
3+
node_modules/

website/.vitepress/config.mts

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
import { defineConfig } from "vitepress";
2+
import { jaConfig } from "./ja.ts";
3+
import { enConfig } from "./en.ts";
4+
5+
export default defineConfig({
6+
title: "🦀 babyrite",
7+
description: "babyrite docs",
8+
themeConfig: {
9+
socialLinks: [
10+
{ icon: "github", link: "https://github.com/m1sk9/babyrite" },
11+
{ icon: "discord", link: "https://run.m1sk9.dev/discord" },
12+
],
13+
footer: {
14+
message:
15+
"babyrite is published under MIT LIcense - Not affiliated with Discord.",
16+
copyright: "© 2023-2024 m1sk9",
17+
},
18+
editLink: {
19+
pattern: "https://github.com/m1sk9/babyrite/edit/main/docs/:path",
20+
text: "Edit this page on GitHub",
21+
},
22+
search: {
23+
provider: "local",
24+
},
25+
},
26+
locales: {
27+
root: {
28+
label: "English",
29+
lang: "en-US",
30+
...enConfig,
31+
},
32+
ja: {
33+
label: "日本語",
34+
lang: "ja-JP",
35+
link: "/ja/",
36+
...jaConfig,
37+
},
38+
},
39+
});

website/.vitepress/en.ts

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
import { defineConfig } from "vitepress";
2+
3+
export const enConfig = defineConfig({
4+
lang: "ja-JP",
5+
themeConfig: {
6+
nav: [
7+
{ text: "Document", link: "/getting-started" },
8+
{ text: "FAQ", link: "/faq" },
9+
// { text: "v1", link: "/migration-v1" },
10+
],
11+
sidebar: [
12+
{
13+
text: "Getting Started",
14+
link: "/getting-started",
15+
},
16+
// {
17+
// text: "Migration to v1",
18+
// link: "/migration-v1"
19+
// },
20+
{
21+
text: "Settings",
22+
link: "/settings",
23+
},
24+
{ text: "FAQ", link: "/faq" },
25+
{
26+
text: "Guide",
27+
collapsed: false,
28+
items: [
29+
{
30+
text: "Preview",
31+
link: "/guide/preview",
32+
},
33+
{
34+
text: "Cache",
35+
link: "/guide/cache",
36+
},
37+
{
38+
text: "Hosting",
39+
link: "/guide/hosting",
40+
},
41+
],
42+
},
43+
],
44+
},
45+
});

website/.vitepress/ja.ts

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import { defineConfig } from "vitepress";
2+
3+
const ja = "/ja";
4+
5+
export const jaConfig = defineConfig({
6+
lang: "ja-JP",
7+
themeConfig: {
8+
nav: [
9+
{ text: "ドキュメント", link: ja + "/getting-started" },
10+
{ text: "FAQ", link: ja + "/faq" },
11+
// { text: "v1", link: ja + "/migration-v1" },
12+
],
13+
sidebar: [
14+
{
15+
text: "はじめる",
16+
link: ja + "/getting-started",
17+
},
18+
// {
19+
// text: "v1 への移行",
20+
// link: ja + "/released-v1"
21+
// },
22+
{
23+
text: "設定",
24+
link: ja + "/settings",
25+
},
26+
{ text: "FAQ", link: ja + "/faq" },
27+
{
28+
text: "ガイド",
29+
collapsed: false,
30+
items: [
31+
{
32+
text: "引用する",
33+
link: ja + "/guide/preview",
34+
},
35+
{
36+
text: "キャッシュ",
37+
link: ja + "/guide/cache",
38+
},
39+
{
40+
text: "Hosting",
41+
link: ja + "/guide/hosting",
42+
},
43+
],
44+
},
45+
],
46+
},
47+
});

website/deno.jsonc

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
// Only for Deno fmt and lint settings
3+
"fmt": {
4+
"exclude": [
5+
".vitepress/cache",
6+
".vitepress/dist"
7+
]
8+
},
9+
"lint": {
10+
"exclude": [
11+
".vitepress/cache",
12+
".vitepress/dist"
13+
]
14+
},
15+
"nodeModulesDir": "auto"
16+
}

0 commit comments

Comments
 (0)