mirror of
https://github.com/EyeTrackVR/EyeTrackVR-Docs.git
synced 2025-09-26 23:09:15 +08:00
refactor: update deps
- added built-in search feature - updated readme - updated to newest version of vitepress
This commit is contained in:
parent
ee321e51f0
commit
8e3b15fa02
@ -13,25 +13,25 @@ Please visit the [documentation site](https://docs.eyetrackvr.dev/) for more inf
|
||||
### install dependencies
|
||||
|
||||
```bash
|
||||
cd vitepress && yarn
|
||||
cd vitepress && pnpm install
|
||||
```
|
||||
|
||||
### start dev server
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
yarn build
|
||||
pnpm build
|
||||
```
|
||||
|
||||
### Serve
|
||||
|
||||
```bash
|
||||
yarn serve
|
||||
pnpm serve
|
||||
```
|
||||
|
||||
## Contribute
|
||||
|
@ -4,97 +4,132 @@
|
||||
//import MyLayout from '../../vue/MyLayout.vue'
|
||||
|
||||
const theme = {
|
||||
logo: {
|
||||
light: '/logo_light.png', dark: '/logo.svg', alt: 'EyeTrackVR Logo'
|
||||
logo: {
|
||||
light: "/logo_light.png",
|
||||
dark: "/logo.svg",
|
||||
alt: "EyeTrackVR Logo",
|
||||
},
|
||||
siteTitle: "EyeTrackVR Docs",
|
||||
/* Note the footer will not show when sidebar is active */
|
||||
search: {
|
||||
provider: "local",
|
||||
},
|
||||
footer: {
|
||||
message: "Released under the MIT License.",
|
||||
copyright: "Copyright © 2022-present ETVR",
|
||||
},
|
||||
nav: [
|
||||
{
|
||||
text: "About",
|
||||
items: [
|
||||
{ text: "About Us", link: "/about" },
|
||||
{ text: "Development Road Map", link: "/dev_roadmap" },
|
||||
],
|
||||
},
|
||||
siteTitle: 'EyeTrackVR Docs',
|
||||
/* Note the footer will not show when sidebar is active */
|
||||
footer: {
|
||||
message: "Released under the MIT License.",
|
||||
copyright: "Copyright © 2022-present ETVR",
|
||||
{ text: "Contact", link: "/contact" },
|
||||
],
|
||||
sidebar: [
|
||||
{
|
||||
text: "Getting Started",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Introduction", link: "/getting_started/intro" },
|
||||
{
|
||||
text: "Things to know before you start",
|
||||
link: "/getting_started/things_to_know",
|
||||
},
|
||||
{ text: "LED Safety", link: "/getting_started/led_safety" },
|
||||
],
|
||||
},
|
||||
nav: [
|
||||
{
|
||||
text: "How to Build",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Full Build Guide", link: "/how_to_build/full_build" },
|
||||
{ text: "Part List", link: "/how_to_build/parts_list" },
|
||||
{
|
||||
text: 'About',
|
||||
items: [
|
||||
{ text: 'About Us', link: '/about' },
|
||||
{ text: 'Development Road Map', link: '/dev_roadmap' },
|
||||
]
|
||||
text: "How to Create your own Camera Mount",
|
||||
link: "/how_to_build/creating_your_own_mount",
|
||||
},
|
||||
{ text: "Contact", link: "/contact" },
|
||||
],
|
||||
sidebar: [
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Firmware Guide",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Introduction", link: "/firmware_guide/firmware" },
|
||||
{
|
||||
text: "Getting Started",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Introduction", link: "/getting_started/intro" },
|
||||
{ text: "Things to know before you start", link: "/getting_started/things_to_know" },
|
||||
{ text: "LED Safety", link: "/getting_started/led_safety" },
|
||||
],
|
||||
text: "Setup Visual Studio Code environment",
|
||||
link: "/firmware_guide/setup_vscode",
|
||||
},
|
||||
{
|
||||
text: "How to Build",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Full Build Guide", link: "/how_to_build/full_build" },
|
||||
{ text: "Part List", link: "/how_to_build/parts_list" },
|
||||
{ text: "How to Create your own Camera Mount", link: "/how_to_build/creating_your_own_mount" },
|
||||
],
|
||||
text: "Configuring Firmware",
|
||||
link: "/firmware_guide/configure_firmware",
|
||||
},
|
||||
{
|
||||
text: "Firmware Guide",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Introduction", link: "/firmware_guide/firmware" },
|
||||
{ text: "Setup Visual Studio Code environment", link: "/firmware_guide/setup_vscode" },
|
||||
{ text: "Configuring Firmware", link: "/firmware_guide/configure_firmware" },
|
||||
{ text: "Uploading and Updating the Firmware", link: "/firmware_guide/upload_and_update_firmware" },
|
||||
{ text: "Updating PlatformIO", link: "/firmware_guide/update_platformio" },
|
||||
{ text: "Firmware Environments", link: "/firmware_guide/environments" },
|
||||
{ text: "MDNS", link: "/firmware_guide/mdns" },
|
||||
{ text: "REST API", link: "/firmware_guide/rest_api" },
|
||||
],
|
||||
text: "Uploading and Updating the Firmware",
|
||||
link: "/firmware_guide/upload_and_update_firmware",
|
||||
},
|
||||
{
|
||||
text: "Software Guide",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Installing and setting up the ETVR App", link: "/software_guide/eyetrackvr_app_guide" },
|
||||
{ text: "Building the app from source", link: "/software_guide/build_software" },
|
||||
{ text: "Setting up OSC recenter/recalibrate", link: "/software_guide/osc_setup" },
|
||||
],
|
||||
text: "Updating PlatformIO",
|
||||
link: "/firmware_guide/update_platformio",
|
||||
},
|
||||
{ text: "Firmware Environments", link: "/firmware_guide/environments" },
|
||||
{ text: "MDNS", link: "/firmware_guide/mdns" },
|
||||
{ text: "REST API", link: "/firmware_guide/rest_api" },
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Software Guide",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{
|
||||
text: "Installing and setting up the ETVR App",
|
||||
link: "/software_guide/eyetrackvr_app_guide",
|
||||
},
|
||||
{
|
||||
text: "Miscellaneous",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "VR Chat Avatar Setup", link: "/misc/vrc_avatar_setup" },
|
||||
{ text: "FAQ", link: "/misc/faq" },
|
||||
],
|
||||
text: "Building the app from source",
|
||||
link: "/software_guide/build_software",
|
||||
},
|
||||
{
|
||||
text: "Development",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Docs", link: "/development/docs/dev_docs" },
|
||||
{ text: "Edit Docs", link: "/development/docs/pages" },
|
||||
{ text: "Standards", link: "/development/docs/standards" },
|
||||
],
|
||||
text: "Setting up OSC recenter/recalibrate",
|
||||
link: "/software_guide/osc_setup",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Miscellaneous",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "VR Chat Avatar Setup", link: "/misc/vrc_avatar_setup" },
|
||||
{ text: "FAQ", link: "/misc/faq" },
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Development",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Docs", link: "/development/docs/dev_docs" },
|
||||
{ text: "Edit Docs", link: "/development/docs/pages" },
|
||||
{ text: "Standards", link: "/development/docs/standards" },
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Archive",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{
|
||||
text: "Archive",
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: "Prepare to solder IR LED PCB V2's", link: "/archive/fox_ir_v2_build_instructions" },
|
||||
],
|
||||
text: "Prepare to solder IR LED PCB V2's",
|
||||
link: "/archive/fox_ir_v2_build_instructions",
|
||||
},
|
||||
],
|
||||
socialLinks: [
|
||||
{ icon: 'github', link: 'https://github.com/EyeTrackVR/EyeTrackVR' },
|
||||
{ icon: 'discord', link: 'https://discord.gg/kkXYbVykZX' }
|
||||
]
|
||||
}
|
||||
],
|
||||
},
|
||||
],
|
||||
socialLinks: [
|
||||
{ icon: "github", link: "https://github.com/EyeTrackVR/EyeTrackVR" },
|
||||
{ icon: "discord", link: "https://discord.gg/kkXYbVykZX" },
|
||||
],
|
||||
};
|
||||
|
||||
const ThemeSettings = {}
|
||||
|
||||
|
@ -1,22 +0,0 @@
|
||||
//vite.config.ts
|
||||
import { SearchPlugin } from "vitepress-plugin-search";
|
||||
import { defineConfig } from "vite";
|
||||
|
||||
// https://github.com/nextapps-de/flexsearch#options
|
||||
var flexSearchIndexOptions = {
|
||||
preset: "score",
|
||||
cache: 1000,
|
||||
context: true,
|
||||
}
|
||||
|
||||
//default options
|
||||
var options = {
|
||||
...flexSearchIndexOptions,
|
||||
previewLength: 62,
|
||||
buttonLabel: "Search",
|
||||
placeholder: "Search docs",
|
||||
};
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [SearchPlugin(options)],
|
||||
});
|
@ -15,15 +15,14 @@
|
||||
"update-deps": "pnpm up -Li"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/flexsearch": "^0.7.3",
|
||||
"@types/flexsearch": "^0.7.4",
|
||||
"flexsearch": "^0.7.31",
|
||||
"markdown-it": "^13.0.1",
|
||||
"postcss": "^8.4.24",
|
||||
"postcss": "^8.4.30",
|
||||
"postcss-flexbugs-fixes": "^5.0.2",
|
||||
"postcss-preset-env": "^8.4.2",
|
||||
"tailwindcss": "^3.3.2",
|
||||
"vitepress": "1.0.0-beta.1",
|
||||
"vitepress-plugin-search": "1.0.4-alpha.20",
|
||||
"postcss-preset-env": "^9.1.4",
|
||||
"tailwindcss": "^3.3.3",
|
||||
"vitepress": "1.0.0-rc.20",
|
||||
"vue": "^3.3.4"
|
||||
}
|
||||
}
|
||||
|
1375
vitepress/pnpm-lock.yaml
generated
1375
vitepress/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user