Giter VIP home page Giter VIP logo

docs's Introduction

Mendix Documentation badge

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

Build status:

  • master Build Status
  • development Build Status

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

  1. Open a terminal window. In Windows, you can run this by pressing Win + R, typing cmd, and pressing Enter.

  2. Go to the folder where the documentation resides: cd C:\Projects\Mendix\docs (assuming you have put it in this folder).

  3. 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

  4. 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

Windows

The steps in this section assume you have installed Hugo and Node in the root directory of your local repository. For example, Hugo is installed in C:\Projects\Mendix\docs\hugo. If this is not the case, you will have to edit the commands in step 3 to reflect their install paths.

Running the server is done by performing the following steps:

  1. In a terminal window navigate to your local repository directory.
  2. Run command SETLOCAL.
  3. Run command SET PATH="%PATH%;C:\Projects\Mendix\docs\node;C:\Projects\Mendix\docs\hugo".
  4. Run command npm.cmd run win-serve-test.
  5. Wait for the site to build, it can take over 30 seconds.
  6. When it's done, open a browser and go to http://localhost:4000.
Other

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

It takes a few seconds 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:

  1. Install Docker and Docker Compose.

  2. Build the Docker images with:

    docker-compose build
  3. 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.

docs's People

Contributors

markvanments avatar connorland avatar mariashaposhnikova avatar jandevriesmendix avatar smarki avatar jeltemx avatar ilagordhan avatar zwartd avatar isamu-tanaka avatar luyao-zhang-1 avatar iisaku avatar joostverhoog avatar r0b1n avatar loket4 avatar kevinvlaanderen avatar zlogic avatar feddovanede avatar kesslera avatar old-profile avatar timvansteenbergen avatar jtwaleson avatar criccle avatar tolene avatar andreaslennevi avatar mmehmetaliizci avatar andries-smit avatar roelandsalij avatar diego-antonelli avatar jpulleman avatar ironthorn avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.