Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 821 Bytes

README.md

File metadata and controls

33 lines (24 loc) · 821 Bytes
Raw

MaaS-API.org

Sourcecode for the MaaS-API.org documentation project.

Use

In order to use the files in this repository, you will need to install some dependencies:

  • Hugo static site generator
  • NPM to handle dependencies
  • Git to deploy changes

Submodule

There is one submodule in this project, which can be initialized with the following commands:

$ git submodule init
$ git submodule update

Build

In order to build the static site, simply run the following comand:

hugo

There will be a (new) folder called public containing a static HTML site.

Deploy

Once the site is built, it can be deployed to GitHub Pages with the following command:

npm run-script deploy