Skip to content

Latest commit

 

History

History
52 lines (28 loc) · 3.28 KB

README.md

File metadata and controls

52 lines (28 loc) · 3.28 KB
Raw

Mendix Documentation badge badge badge

This repository contains the Mendix documentation, which is served on https://docs.mendix.com.

Build status:

  • production Build Status
  • development Build Status

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation. It will guide you through the process of submitting updates to the docs directly from Github or from a local branch.

Local Build

You can clone a local copy of the repository and build local previews. The Mendix documentation is built on top of Hugo and Node.JS. The theme of the page is based on Docsy. To develop the documentation locally, follow the steps in the next section.

Setting Up

Cloning the Repo

To clone the repo please keep in mind:

  • If you are running on Windows, the directory path for the local directory should not be too long, otherwise some files will reach the limits of git’s file length. A base path of up to 50 characters works - 64 characters is currently too long.

Installing Dependencies

  1. Download and install the LTS version of NodeJS.
  2. In a terminal at the root of the repository run: npm install.

Running the Server

To run a local version of the site:

  1. Run one of the following commands:

    • npm run build

    • ./node_modules/.bin/hugo server --environment development – in this case, you can use different parameters to build the site in different ways—for example, build a copy of the production site and save it locally.

      The path syntax prefacing hugo may be different based on your operating system and terminal you use.

    Once the site is built you will see a table indicating how many pages have been created. You will need to wait until the server is set up before you can see the site.

  2. Go to http://localhost:1313/ and see the site live.

See the Hugo Server documentation for more options (for example, if you want to change the port on which the site is published)

Potential Issues

If you are using a Mac, you might get an error too many open files or fatal error: pipe failed. By default, your Mac is probably set to restrict the number of open files. You will need to override this, see Docsy known issues for more information.

If your system has a low memory limit, add the --renderToDisk parameter to the Hugo command, for example hugo server --environment development --renderToDisk. With this option, Hugo will only load pages on demand; without the --renderToDisk option, Hugo will load all documentation into memory for faster access.