Docs dev & build
GazePlotterDocs uses VitePress to build and serve the documentation site from
.md files. The development set-up requires that you have Node (14 or higher) installed.
More about the dev & build process of the main app can be found here.
Download the source code
The code can be downloaded as a zip file, but it is highly recommended to either fork the repository or clone it.
Fork the repository
To fork the repository, click the
Fork button in the top-right corner of the GitHub repository.
Clone the repository
To clone the repository, open the terminal and run the following command:
git clone https://github.com/misavojte/GazePlotterDocs.git
In the terminal, make sure you are in the project's root directory. Then, to start Vite server and run dev version of project locally on
npm run dev
Build the docs
To build the docs, use:
npm run build
Production build is located in the
.vitepress/dist directory. For its preview on
npm run preview