Development Documentation for the EyeTrackVR Docs Site ​

This is the documentation for the EyeTrackVR Docs site. It is built using VitePress.

Getting Started ​

Prerequisites ​

• Node.js (v14.15.4 or higher)
• Yarn (v1.22.10 or higher)
• Git (v2.30.1 or higher)
• VSCode (v1.56.2 or higher)

Installation ​

1. Clone the repo

   sh

   git clone https://github.com/EyeTrackVR/EyeTrackVR-Docs.git

   1
   

2. Navigate to the vitepress folder

   sh

   cd vitepress

   1
   

3. Install Yarn packages

   sh

    yarn

   1
   

4. Start the dev server

   sh

   yarn dev

   1
   

5. Open the site in your browser

Contributing ​

Project Structure ​

1. Familiarize yourself with the VitePress documentation.
2. Then, move on to our project specific documentation below.

Standards ​

• All documentation should be written in Markdown or Vue components.
• All file names are snake case and lowercase letters.
• Do not make naming changes to the vitepress folder.
• Do not make major changes to the vitepress folder structure without proir consultation of team members.
• For Vue componentes, follow the Vue3 docs.