Mendix Documentation

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

Build status:

master
development

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation.

Development

There are two ways to develop the documentation: you can run it locally (which is faster) or use Docker. With Docker, you will not have to install Hugo and Node, but you need Docker and Docker Compose.

Local Development

The Mendix documentation is built on top of Hugo and Node.JS. When you want to develop the documentation locally, you need to have both installed.

Prerequisites

Hugo is a static page generator that runs on Go. Make sure you install Hugo following these guides.

Node.js is a JavaScript runtime. You can install it by downloading the installer here. We are using version (12.x.x).

Installing Dependencies

Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.
Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).
Check if you have both Hugo, Node.JS and yarn installed correctly by typing these commands in your terminal and pressing Enter):
hugo version
It should show you the version: Hugo Static Site Generator v0.31.1 xxxx. Note: It is important to match this version number! Because of breaking changes this will not work with Hugo version >= 0.32
node -v
It should show you the version: v12.0.0 (the version number you installed)
yarn -v
It should show you yarn version
If both commands work, there is one more command you need to type to install the dependencies:
yarn install
This will take a while. It will install all project dependencies specified in package.json.

Running the Server

Running the server is done by executing the following command: npm run serve.

It takes a few seconds (Windows can take longer) to build the site and setup the server.

When it's done, open a browser and go to http://localhost:4000.

Gulp Tasks

By running yarn run help, you can access the different tasks that are used when building the website.

Please note that the task check:html is currently broken in Windows.

Using Docker for Development

A Docker setup potentially makes development and deployment easier.

To use it, follow these steps:

Install Docker and Docker Compose.
Build the Docker images with:
```
docker-compose build
```
Then run:
```
docker-compose up
```
This will start up the server and watches for changes. You should be able to visit http://localhost:4000/ to view the site.

Mendix Documentation

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

Build status:

master
development

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation.

Development

There are two ways to develop the documentation: you can run it locally (which is faster) or use Docker. With Docker, you will not have to install Hugo and Node, but you need Docker and Docker Compose.

Local Development

The Mendix documentation is built on top of Hugo and Node.JS. When you want to develop the documentation locally, you need to have both installed.

Prerequisites

Hugo is a static page generator that runs on Go. Make sure you install Hugo following these guides.

Node.js is a JavaScript runtime. You can install it by downloading the installer here. We are using version (12.x.x).

Installing Dependencies

Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.
Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).
Check if you have both Hugo, Node.JS and yarn installed correctly by typing these commands in your terminal and pressing Enter):
hugo version
It should show you the version: Hugo Static Site Generator v0.31.1 xxxx. Note: It is important to match this version number! Because of breaking changes this will not work with Hugo version >= 0.32
node -v
It should show you the version: v12.0.0 (the version number you installed)
yarn -v
It should show you yarn version
If both commands work, there is one more command you need to type to install the dependencies:
yarn install
This will take a while. It will install all project dependencies specified in package.json.

Running the Server

Running the server is done by executing the following command: npm run serve.

It takes a few seconds (Windows can take longer) to build the site and setup the server.

When it's done, open a browser and go to http://localhost:4000.

Gulp Tasks

By running yarn run help, you can access the different tasks that are used when building the website.

Please note that the task check:html is currently broken in Windows.

Using Docker for Development

A Docker setup potentially makes development and deployment easier.

To use it, follow these steps:

Install Docker and Docker Compose.
Build the Docker images with:
```
docker-compose build
```
Then run:
```
docker-compose up
```
This will start up the server and watches for changes. You should be able to visit http://localhost:4000/ to view the site.

Mendix Documentation

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

Build status:

master
development

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation.

Development

There are two ways to develop the documentation: you can run it locally (which is faster) or use Docker. With Docker, you will not have to install Hugo and Node, but you need Docker and Docker Compose.

Local Development

The Mendix documentation is built on top of Hugo and Node.JS. When you want to develop the documentation locally, you need to have both installed.

Prerequisites

Hugo is a static page generator that runs on Go. Make sure you install Hugo following these guides.

Node.js is a JavaScript runtime. You can install it by downloading the installer here. We are using version (12.x.x).

Installing Dependencies

Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.
Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).
Check if you have both Hugo, Node.JS and yarn installed correctly by typing these commands in your terminal and pressing Enter):
hugo version
It should show you the version: Hugo Static Site Generator v0.31.1 xxxx. Note: It is important to match this version number! Because of breaking changes this will not work with Hugo version >= 0.32
node -v
It should show you the version: v12.0.0 (the version number you installed)
yarn -v
It should show you yarn version
If both commands work, there is one more command you need to type to install the dependencies:
yarn install
This will take a while. It will install all project dependencies specified in package.json.

Running the Server

Running the server is done by executing the following command: npm run serve.

It takes a few seconds (Windows can take longer) to build the site and setup the server.

When it's done, open a browser and go to http://localhost:4000.

Gulp Tasks

By running yarn run help, you can access the different tasks that are used when building the website.

Please note that the task check:html is currently broken in Windows.

Using Docker for Development

A Docker setup potentially makes development and deployment easier.

To use it, follow these steps:

Install Docker and Docker Compose.
Build the Docker images with:
```
docker-compose build
```
Then run:
```
docker-compose up
```
This will start up the server and watches for changes. You should be able to visit http://localhost:4000/ to view the site.

Mendix Documentation

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

Build status:

master
development

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation.

Development

There are two ways to develop the documentation: you can run it locally (which is faster) or use Docker. With Docker, you will not have to install Hugo and Node, but you need Docker and Docker Compose.

Local Development

The Mendix documentation is built on top of Hugo and Node.JS. When you want to develop the documentation locally, you need to have both installed.

Prerequisites

Hugo is a static page generator that runs on Go. Make sure you install Hugo following these guides.

Node.js is a JavaScript runtime. You can install it by downloading the installer here. We are using version (12.x.x).

Installing Dependencies

Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.
Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).
Check if you have both Hugo, Node.JS and yarn installed correctly by typing these commands in your terminal and pressing Enter):
hugo version
It should show you the version: Hugo Static Site Generator v0.31.1 xxxx. Note: It is important to match this version number! Because of breaking changes this will not work with Hugo version >= 0.32
node -v
It should show you the version: v12.0.0 (the version number you installed)
yarn -v
It should show you yarn version
If both commands work, there is one more command you need to type to install the dependencies:
yarn install
This will take a while. It will install all project dependencies specified in package.json.

Running the Server

Running the server is done by executing the following command: npm run serve.

It takes a few seconds (Windows can take longer) to build the site and setup the server.

When it's done, open a browser and go to http://localhost:4000.

Gulp Tasks

By running yarn run help, you can access the different tasks that are used when building the website.

Please note that the task check:html is currently broken in Windows.

Using Docker for Development

A Docker setup potentially makes development and deployment easier.

To use it, follow these steps:

Install Docker and Docker Compose.
Build the Docker images with:
```
docker-compose build
```
Then run:
```
docker-compose up
```
This will start up the server and watches for changes. You should be able to visit http://localhost:4000/ to view the site.

Mendix Documentation

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

Build status:

master
development

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation.

Development

There are two ways to develop the documentation: you can run it locally (which is faster) or use Docker. With Docker, you will not have to install Hugo and Node, but you need Docker and Docker Compose.

Local Development

The Mendix documentation is built on top of Hugo and Node.JS. When you want to develop the documentation locally, you need to have both installed.

Prerequisites

Hugo is a static page generator that runs on Go. Make sure you install Hugo following these guides.

Node.js is a JavaScript runtime. You can install it by downloading the installer here. We are using version (12.x.x).

Installing Dependencies

Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.
Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).
Check if you have both Hugo, Node.JS and yarn installed correctly by typing these commands in your terminal and pressing Enter):
hugo version
It should show you the version: Hugo Static Site Generator v0.31.1 xxxx. Note: It is important to match this version number! Because of breaking changes this will not work with Hugo version >= 0.32
node -v
It should show you the version: v12.0.0 (the version number you installed)
yarn -v
It should show you yarn version
If both commands work, there is one more command you need to type to install the dependencies:
yarn install
This will take a while. It will install all project dependencies specified in package.json.

Running the Server

Running the server is done by executing the following command: npm run serve.

It takes a few seconds (Windows can take longer) to build the site and setup the server.

When it's done, open a browser and go to http://localhost:4000.

Gulp Tasks

By running yarn run help, you can access the different tasks that are used when building the website.

Please note that the task check:html is currently broken in Windows.

Using Docker for Development

A Docker setup potentially makes development and deployment easier.

To use it, follow these steps:

Install Docker and Docker Compose.
Build the Docker images with:
```
docker-compose build
```
Then run:
```
docker-compose up
```
This will start up the server and watches for changes. You should be able to visit http://localhost:4000/ to view the site.

Mendix Documentation

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

Build status:

master
development

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation.

Development

There are two ways to develop the documentation: you can run it locally (which is faster) or use Docker. With Docker, you will not have to install Hugo and Node, but you need Docker and Docker Compose.

Local Development

The Mendix documentation is built on top of Hugo and Node.JS. When you want to develop the documentation locally, you need to have both installed.

Prerequisites

Hugo is a static page generator that runs on Go. Make sure you install Hugo following these guides.

Node.js is a JavaScript runtime. You can install it by downloading the installer here. We are using version (12.x.x).

Installing Dependencies

Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.
Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).
Check if you have both Hugo, Node.JS and yarn installed correctly by typing these commands in your terminal and pressing Enter):
hugo version
It should show you the version: Hugo Static Site Generator v0.31.1 xxxx. Note: It is important to match this version number! Because of breaking changes this will not work with Hugo version >= 0.32
node -v
It should show you the version: v12.0.0 (the version number you installed)
yarn -v
It should show you yarn version
If both commands work, there is one more command you need to type to install the dependencies:
yarn install
This will take a while. It will install all project dependencies specified in package.json.

Running the Server

Running the server is done by executing the following command: npm run serve.

It takes a few seconds (Windows can take longer) to build the site and setup the server.

When it's done, open a browser and go to http://localhost:4000.

Gulp Tasks

By running yarn run help, you can access the different tasks that are used when building the website.

Please note that the task check:html is currently broken in Windows.

Using Docker for Development

A Docker setup potentially makes development and deployment easier.

To use it, follow these steps:

Install Docker and Docker Compose.
Build the Docker images with:
```
docker-compose build
```
Then run:
```
docker-compose up
```
This will start up the server and watches for changes. You should be able to visit http://localhost:4000/ to view the site.

Mendix Documentation

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

Build status:

master
development

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation.

Development

There are two ways to develop the documentation: you can run it locally (which is faster) or use Docker. With Docker, you will not have to install Hugo and Node, but you need Docker and Docker Compose.

Local Development

The Mendix documentation is built on top of Hugo and Node.JS. When you want to develop the documentation locally, you need to have both installed.

Prerequisites

Hugo is a static page generator that runs on Go. Make sure you install Hugo following these guides.

Node.js is a JavaScript runtime. You can install it by downloading the installer here. We are using version (12.x.x).

Installing Dependencies

Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.
Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).
Check if you have both Hugo, Node.JS and yarn installed correctly by typing these commands in your terminal and pressing Enter):
hugo version
It should show you the version: Hugo Static Site Generator v0.31.1 xxxx. Note: It is important to match this version number! Because of breaking changes this will not work with Hugo version >= 0.32
node -v
It should show you the version: v12.0.0 (the version number you installed)
yarn -v
It should show you yarn version
If both commands work, there is one more command you need to type to install the dependencies:
yarn install
This will take a while. It will install all project dependencies specified in package.json.

Running the Server

Running the server is done by executing the following command: npm run serve.

It takes a few seconds (Windows can take longer) to build the site and setup the server.

When it's done, open a browser and go to http://localhost:4000.

Gulp Tasks

By running yarn run help, you can access the different tasks that are used when building the website.

Please note that the task check:html is currently broken in Windows.

Using Docker for Development

A Docker setup potentially makes development and deployment easier.

To use it, follow these steps:

Install Docker and Docker Compose.
Build the Docker images with:
```
docker-compose build
```
Then run:
```
docker-compose up
```
This will start up the server and watches for changes. You should be able to visit http://localhost:4000/ to view the site.

Mendix Documentation

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

Build status:

master
development

Contribute

Want to contribute? Take a look at How to Contribute to the Mendix Documentation.

Development

There are two ways to develop the documentation: you can run it locally (which is faster) or use Docker. With Docker, you will not have to install Hugo and Node, but you need Docker and Docker Compose.

Local Development

The Mendix documentation is built on top of Hugo and Node.JS. When you want to develop the documentation locally, you need to have both installed.

Prerequisites

Hugo is a static page generator that runs on Go. Make sure you install Hugo following these guides.

Node.js is a JavaScript runtime. You can install it by downloading the installer here. We are using version (12.x.x).

Installing Dependencies

Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.
Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).
Check if you have both Hugo, Node.JS and yarn installed correctly by typing these commands in your terminal and pressing Enter):
hugo version
It should show you the version: Hugo Static Site Generator v0.31.1 xxxx. Note: It is important to match this version number! Because of breaking changes this will not work with Hugo version >= 0.32
node -v
It should show you the version: v12.0.0 (the version number you installed)
yarn -v
It should show you yarn version
If both commands work, there is one more command you need to type to install the dependencies:
yarn install
This will take a while. It will install all project dependencies specified in package.json.

Running the Server

Running the server is done by executing the following command: npm run serve.

It takes a few seconds (Windows can take longer) to build the site and setup the server.

When it's done, open a browser and go to http://localhost:4000.

Gulp Tasks

By running yarn run help, you can access the different tasks that are used when building the website.

Please note that the task check:html is currently broken in Windows.

Using Docker for Development

A Docker setup potentially makes development and deployment easier.

To use it, follow these steps:

Install Docker and Docker Compose.
Build the Docker images with:
```
docker-compose build
```
Then run:
```
docker-compose up
```
This will start up the server and watches for changes. You should be able to visit http://localhost:4000/ to view the site.

Name		Name	Last commit message	Last commit date
_assets		_assets
_gulp		_gulp
_scripts		_scripts
content		content
data		data
snippets		snippets
static		static
templates		templates
themes/mendix		themes/mendix
.gitignore		.gitignore
.nvmrc		.nvmrc
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
Gulpfile.js		Gulpfile.js
LICENSE		LICENSE
README.md		README.md
config.yaml		config.yaml
docker-compose.yml		docker-compose.yml
manifest_accp.yml		manifest_accp.yml
manifest_prod.yml		manifest_prod.yml
package.json		package.json
run_json.js		run_json.js
yarn.lock		yarn.lock

Name		Name	Last commit message	Last commit date
_assets		_assets
_gulp		_gulp
_scripts		_scripts
content		content
data		data
snippets		snippets
static		static
templates		templates
themes/mendix		themes/mendix
.gitignore		.gitignore
.nvmrc		.nvmrc
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
Gulpfile.js		Gulpfile.js
LICENSE		LICENSE
README.md		README.md
config.yaml		config.yaml
docker-compose.yml		docker-compose.yml
manifest_accp.yml		manifest_accp.yml
manifest_prod.yml		manifest_prod.yml
package.json		package.json
run_json.js		run_json.js
yarn.lock		yarn.lock

Name		Name	Last commit message	Last commit date
_assets		_assets
_gulp		_gulp
_scripts		_scripts
content		content
data		data
snippets		snippets
static		static
templates		templates
themes/mendix		themes/mendix
.gitignore		.gitignore
.nvmrc		.nvmrc
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
Gulpfile.js		Gulpfile.js
LICENSE		LICENSE
README.md		README.md
config.yaml		config.yaml
docker-compose.yml		docker-compose.yml
manifest_accp.yml		manifest_accp.yml
manifest_prod.yml		manifest_prod.yml
package.json		package.json
run_json.js		run_json.js
yarn.lock		yarn.lock

Name		Name	Last commit message	Last commit date
_assets		_assets
_gulp		_gulp
_scripts		_scripts
content		content
data		data
snippets		snippets
static		static
templates		templates
themes/mendix		themes/mendix
.gitignore		.gitignore
.nvmrc		.nvmrc
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
Gulpfile.js		Gulpfile.js
LICENSE		LICENSE
README.md		README.md
config.yaml		config.yaml
docker-compose.yml		docker-compose.yml
manifest_accp.yml		manifest_accp.yml
manifest_prod.yml		manifest_prod.yml
package.json		package.json
run_json.js		run_json.js
yarn.lock		yarn.lock

Name		Name	Last commit message	Last commit date
_assets		_assets
_gulp		_gulp
_scripts		_scripts
content		content
data		data
snippets		snippets
static		static
templates		templates
themes/mendix		themes/mendix
.gitignore		.gitignore
.nvmrc		.nvmrc
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
Gulpfile.js		Gulpfile.js
LICENSE		LICENSE
README.md		README.md
config.yaml		config.yaml
docker-compose.yml		docker-compose.yml
manifest_accp.yml		manifest_accp.yml
manifest_prod.yml		manifest_prod.yml
package.json		package.json
run_json.js		run_json.js
yarn.lock		yarn.lock

Latest commit

History

Folders and files

Repository files navigation

Mendix Documentation

Contribute

Development

Local Development

Prerequisites

Installing Dependencies

Running the Server

Gulp Tasks

Using Docker for Development

About

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

Mendix Documentation

Contribute

Development

Local Development

Prerequisites

Installing Dependencies

Running the Server

Gulp Tasks

Using Docker for Development

About

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

Mendix Documentation

Contribute

Development

Local Development

Prerequisites

Installing Dependencies

Running the Server

Gulp Tasks

Using Docker for Development

About

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

Mendix Documentation

Contribute

Development

Local Development

Prerequisites

Installing Dependencies

Running the Server