Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kinecttovr/k2vr-docs
K2VR documentation source
https://github.com/kinecttovr/k2vr-docs
body-tracking docs hacktoberfest kinect kinecttovr steamvr website
Last synced: 3 months ago
JSON representation
K2VR documentation source
- Host: GitHub
- URL: https://github.com/kinecttovr/k2vr-docs
- Owner: KinectToVR
- License: other
- Created: 2022-05-25T23:37:04.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-20T10:59:52.000Z (4 months ago)
- Last Synced: 2024-10-29T11:12:56.282Z (3 months ago)
- Topics: body-tracking, docs, hacktoberfest, kinect, kinecttovr, steamvr, website
- Language: Astro
- Homepage: https://docs.k2vr.tech
- Size: 23.3 MB
- Stars: 7
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# K2VR documentation source
This repository contains the source files used to generate the Amethyst docs at [docs.k2vr.tech](https://docs.k2vr.tech).
It uses the same docs generator as for HekkyPBR. Created by [@Hyblocker](https://github.com/hyblocker).
### Contributing
If you see any issues, typos, missing information or want to add entire new pages, or provide translations, feel free to make a pull request. Any and all efforts to improve this documentation is welcome.
To know what components are available to you, check out [the playground](https://docs.k2vr.tech/en/playground) and [the source for it](https://github.com/KinectToVR/k2vr-docs/blob/master/src/pages/en/playground.md).
Full GitHub-flavored markdown can be used in docs pages, though you should always check in the browser how things render, especially when nesting items.
### Building
- Clone the `master` branch and navigate to it.
- Install NPM
- Install pnpm with `npm install pnpm --global`
- Initialize the dev environment through pnpm `pnpm i --frozen-lockfile`
You can now start a dev server locally with `pnpm astro dev`
Pages will update automatically in the browser on file save.
The actual pages are stored in `src/pages/[lang]/`
Images and other resources are stored in the `public` folder.
We recommend using VSCode for editing, because it will let you easily re-generate search through the NPM Scripts panel.
### License
This documentation is licensed under a Creative Commons CC-BY-NC-SA 4.0 license. Please see the [Creative Commons](https://github.com/KinectToVR/k2vr-docs/blob/master/LICENSE) for more info.
