Skip to content

Commit 48c44b7

Browse files
committed
docs: update docs
1 parent c2a750d commit 48c44b7

File tree

9 files changed

+433
-43
lines changed

9 files changed

+433
-43
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img src="assets/logo.png" align="right" width="156" alt="logo" />
1+
<img src="docs/public/logo.png" align="right" width="156" alt="logo" />
22

33
# mobx-route
44

assets/logo.png

-478 KB
Binary file not shown.

assets/new-logo.pxz

-1.81 MB
Binary file not shown.

docs/.vitepress/config.mts

Lines changed: 7 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,29 @@
1-
import { defineConfig } from 'vitepress';
1+
import { defineGhPagesDocConfig } from "sborshik/vitepress/define-gh-pages-doc-config";
22

33
import path from 'path';
44
import fs from 'fs';
55

6-
const { version, name: packageName, author, license } = JSON.parse(
6+
const pckgJson = JSON.parse(
77
fs.readFileSync(
88
path.resolve(__dirname, '../../package.json'),
99
{ encoding: 'utf-8' },
1010
),
1111
);
1212

13-
export default defineConfig({
14-
title: packageName.replace(/-/g, ' '),
15-
description: `${packageName.replace(/-/g, ' ')} documentation`,
16-
base: `/${packageName}/`,
17-
lastUpdated: true,
18-
head: [
19-
['link', { rel: 'icon', href: `/${packageName}/logo.png` }],
20-
],
21-
transformHead: ({ pageData, head }) => {
22-
head.push(['meta', { property: 'og:site_name', content: packageName }]);
23-
head.push(['meta', { property: 'og:title', content: pageData.title }]);
24-
if (pageData.description) {
25-
head.push(['meta', { property: 'og:description', content: pageData.description }]);
26-
}
27-
head.push(['meta', { property: 'og:image', content: `https://${author}.github.io/${packageName}/logo.png` }]);
28-
29-
return head
30-
},
13+
export default defineGhPagesDocConfig(pckgJson, {
14+
createdYear:'2025',
3115
themeConfig: {
32-
logo: '/logo.png',
33-
search: {
34-
provider: 'local'
35-
},
3616
nav: [
3717
{ text: 'Home', link: '/' },
3818
{ text: 'Introduction', link: '/introduction/getting-started' },
3919
{
40-
text: `v${version}`,
20+
text: `${pckgJson.version}`,
4121
items: [
4222
{
4323
items: [
4424
{
45-
text: `v${version}`,
46-
link: `https://github.com/${author}/${packageName}/releases/tag/v${version}`,
25+
text: `${pckgJson.version}`,
26+
link: `https://github.com/${pckgJson.author}/${pckgJson.name}/releases/tag/${pckgJson.version}`,
4727
},
4828
],
4929
},
@@ -95,14 +75,5 @@ export default defineConfig({
9575
],
9676
}
9777
],
98-
99-
footer: {
100-
message: `Released under the ${license} License.`,
101-
copyright: `Copyright © 2025-PRESENT ${author}`,
102-
},
103-
104-
socialLinks: [
105-
{ icon: 'github', link: `https://github.com/${author}/${packageName}` },
106-
],
10778
},
10879
});

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"devDependencies": {
55
"@iconify-json/logos": "^1.1.44",
66
"@unocss/preset-icons": "^0.61.9",
7-
"sborshik": "^1.0.12",
7+
"sborshik": "^1.0.25",
88
"unocss": "^0.61.9",
99
"vite": "^5.3.1",
1010
"vitepress": "^1.6.4"

0 commit comments

Comments
 (0)