Documentation

What is CMintS?

CMintS is a CMS and Static Site Generator for single and multi language websites creation. CMintS is quite easy to install, it has only few requirements.

Note: If you would like to deploy your first app to the web without installing CMintS globally, check Quick Start guide.

Requirements and installation

Installing CMintS is quite easy, ensure that you have Node.js installed and run the commands below:

npm install -g cmints

Example projects

In order to have quick start it's recommended to generate example project by running, one of the commands below:

# Generates single language project
cmints --example single

# Generates multi language project
cmints --example multi

# Generates multi language project in the {PATH} directory.
cmints {PATH} --example

The example project is the content of current website, which can also be found in the github.

Starting server

For the production:

# Run http server serving current folder
cmints --start

# Replace optional {PATH} with the path to the folder you wish to serve.
cmints {PATH} --start

# https server: Replace {PATH} with the path to the folder you wish to serve
# Replace {PRIVATE_KEY} with the path to the private key file
# Replace {CERTIFICATE} with the path to the certiface file
cmints {PATH} --start --https -k {PRIVATE_KEY} -c {CERTIFICATE}

For development:

# Run http server serving current folder Use --no-cache flag to disable the caching
cmints --start --no-cache

# Replace optional {PATH} with the path to the folder you wish to serve
cmints {PATH} --start --no-cache

Generating static content

Run one of the command below in order to generate static content

# Generate static content of current directory
cmints --static

# Replace optional {PATH} with the path to the project for content generation
cmints {PATH} --static