/42ity-org-website

42ITy.org website source, to generate 42ity.github.io

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Introduction

These are the source pages of 42ITy™ website, in Asciidoc format.

These are used for generating the static HTML content of 42ITy™ website.

A modified version of Asciidoc Bootstrap backend is used, and included in the present repository to fit some specific needs. That also implies that you do not need to install the asciidoc-bootstrap backend.

Requirements

  • At least for now, the build system (simple Makefile) needs a Linux or Unix (whichever one) system, and the 'make' command to be available.

  • Install Asciidoc: either using your OS packages manager or from source. Refer to the Asciidoc website for more information.

  • The generation of REST API documentation in HTML format requires raml2html. You can install it using:

:; npm i -g raml2html

For more information, check the Github project page

An excellent source for up-to-date Node.js packages for Linux systems is NodeSource

  • Get the content of the present repository

:; git clone https://github.com/42ity/42ity-org-website.git

Generate the website

From the root of the 42ity-org-website directory, simply call:

:; make

This will build all the HTML files needed for the website.

If you are a maintainer of the 42ITy™ website, you will also want to publish your modifications. To do so, call:

:; make install

Then go to the '42ity.github.io' subdirectory, and add/commit the needed files. All files under this submodule/repository will go public on http://42ity.org as soon as these are committed.

Licenses

The present work is derived from Asciidoc Bootstrap made by Dan Allen and Laurent Laville. It is released under the Apache Licence Version 2.0.