mirror of
https://github.com/EyeTrackVR/EyeTrackVR-Docs.git
synced 2025-11-04 14:49:44 +08:00
- added built-in search feature - updated readme - updated to newest version of vitepress
59 lines
1.5 KiB
Markdown
59 lines
1.5 KiB
Markdown
[](https://github.com/EyeTrackVR/EyeTrackVR-Docs/actions/workflows/build_release_vitepress.yml)
|
|
|
|
<img src="./img/logo.png" alt="Logo" align="right" height="76"/>
|
|
|
|
# EyeTrackVR Documentation Site
|
|
|
|
This is the source code for the [EyeTrackVR project](https://github.com/EyeTrackVR) documentation site. It is built using [VitePress](https://vitepress.vuejs.org/).
|
|
|
|
Please visit the [documentation site](https://docs.eyetrackvr.dev/) for more information.
|
|
|
|
## Development
|
|
|
|
### install dependencies
|
|
|
|
```bash
|
|
cd vitepress && pnpm install
|
|
```
|
|
|
|
### start dev server
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
### Build
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
### Serve
|
|
|
|
```bash
|
|
pnpm serve
|
|
```
|
|
|
|
## Contribute
|
|
|
|
Please see the [contributing guide](./CONTRIBUTING.md) for all information.
|
|
|
|
### Standards
|
|
|
|
Please see the [standards guide](./STANDARDS.md) for all information.
|
|
|
|
## Contact
|
|
|
|
Please join our discord for updates and any questions.
|
|
|
|
[](https://discord.gg/kkXYbVykZX)
|
|
|
|
# Licenses
|
|
|
|
[](./LICENSE)
|
|
|
|
***All software is under the [MIT License](http://opensource.org/licenses/MIT).
|
|
All documentation, including the [Wiki](https://github.com/EyeTrackVR/EyeTrackVR/wiki), is under the Creative Commons CC-BY-SA-4.0 license***.
|
|
|
|
[Top](#eyetrackvr-documentation-site)
|