Skip to content

Commit 46ec15d

Browse files
committed
vitepress upgrade + local search support
1 parent 869aac0 commit 46ec15d

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

.vitepress/config.js

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ export default {
77
srcDir: 'src',
88
outDir: 'build',
99
base: baseDir,
10-
cleanUrls: 'without-subfolders', // Doesn't seem to function correctly
10+
cleanUrls: true,
1111
appearance: 'dark',
12+
lastUpdated: true,
1213
head: [
1314
[
1415
'meta',
@@ -83,6 +84,9 @@ export default {
8384
logo: '/logo.svg',
8485
siteTitle: 'React Native WebRTC',
8586
outline: 'deep',
87+
search: {
88+
provider: 'local'
89+
},
8690
nav: [
8791
{
8892
text: 'Guides',
@@ -101,10 +105,6 @@ export default {
101105
link: 'https://react-native-webrtc.discourse.group'
102106
}
103107
],
104-
editLink: {
105-
pattern: 'https://github.com/react-native-webrtc/handbook/edit/master/docs/:path',
106-
text: 'Suggest changes to this page'
107-
},
108108
socialLinks: [
109109
{
110110
icon: 'github',
@@ -208,6 +208,10 @@ export default {
208208
}
209209
]
210210
},
211+
editLink: {
212+
pattern: 'https://github.com/react-native-webrtc/handbook/edit/master/src/:path',
213+
text: 'Suggest changes to this page'
214+
},
211215
footer: {
212216
message: 'Released under the Apache 2.0 License',
213217
copyright: 'Copyright © 2023 - React Native WebRTC'

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Powered by [VitePress](https://vitepress.vuejs.org/).
44
`Nodejs >= 16 is necessary.`
55
Built automatically with every push thanks to [GH Actions](https://github.com/react-native-webrtc/handbook/blob/master/.github/workflows/gh-pages.yml).
66

7-
## Want to build and run our handbook locally?
7+
## Want to build and run our handbook?
88

99
Say no more. It's as simple as running one of the following lines.
1010
Entirely depends on your preferred package manager.
@@ -17,8 +17,8 @@ pnpm install && pnpm start
1717

1818
You can now edit the files in the `src` folder and the site should start to reflect any changes you make thanks to live reloading.
1919

20-
## Would you like to lend a hand?
20+
## Got some spare time?
2121

2222
We appreciate all contributions within our organisation.
23-
Please make a pull request, no matter how small, all contributions are valuable!
24-
Every little helps.
23+
Please make a pull request. No matter how small.
24+
All contributions are valuable. Every little helps.

package.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,7 @@
99
"serve": "vitepress serve"
1010
},
1111
"devDependencies": {
12-
"vitepress": "1.0.0-alpha.65",
13-
"vue": "^3.2.47",
14-
"flexsearch": "^0.7.31",
15-
"markdown-it": "^13.0.1",
16-
"vitepress-plugin-search": "1.0.4-alpha.19"
12+
"vitepress": "1.0.0-alpha.71",
13+
"vue": "^3.2.47"
1714
}
1815
}

0 commit comments

Comments
 (0)