Mendix documentation repository
The Mendix Documentation repository contains all the documentation for Mendix, a low-code development platform. The documentation is served on the website https://docs.mendix.com. This document provides information on how to contribute to the documentation and how to set up a local copy of the documentation for development purposes.
To clone the repo and set up a local version of the Mendix documentation, follow these steps:
If you are running on Windows, make sure the directory path for the local directory is not too long, as some files may reach the limits of git’s file length. A base path of up to 50 characters works, while 64 characters is currently too long.
Download and install the LTS version of NodeJS.
In a terminal at the root of the repository, run the command npm install to install the necessary dependencies.
To run a local version of the site, use one of the following commands:
npm run build./node_modules/.bin/hugo server --environment developmentNote: The path syntax prefacing hugo may be different based on your operating system and the terminal you are using.
Once the site is built, visit http://localhost:1313/ to see the site live.
Refer to the Hugo Server documentation for more options, such as changing the port on which the site is published.
The Mendix Documentation repository allows users to clone a local copy of the Mendix documentation and build local previews. The documentation is built on top of Hugo and Node.JS, with a theme based on Docsy. To set up the local documentation, users need to clone the repository, install the necessary dependencies, and run a local server. Potential issues, such as file length limits on Windows and low memory limits, are also addressed in the documentation.