Documentation Setup

VitePress

This documentation is using VitePress to render Markdown files to static HTML to make it easily accessible and presentable via the internet. Markdown is a simple and easy-to-use markup language. For editing the markdown files, no special tools other than a text editor are required, although Visual Studio Code with the official Vue extension are recommended according to the official VitePress documentation.

For configuration specifically, please refer to the official VitePress documentation, as it covers everything regarding configuration of the application in detail.

Deployment

VitePress is automatically deployed by a Jenkins pipeline to a Docker container on the remote server (Metanet), which has its own section in this documentation further below. The necessary Dockerfile and Jenkinsfile can both be found at the root level of the repository that serves this documentation. As long as Jenkins is responsible for the deployment of the Docker container, manual installment of the container is not necessary.