Table of contents
How it works?
We use DocPad, a static generator in NodeJS.
Install Node.JS, if you don't have it yet.
Once you have dependencies installed, you just need to:
Clone the project:
git clone firstname.lastname@example.org:liferay/alloyui.com.git
Then go to the project's folder:
Install the dependencies:
And finally run:
npm run watch
Now you can see the website running in
The basic structure of the project is given in the following way:
. |-- out/ |-- src/ | |-- documents/ | |-- files/ | |-- layouts/ |-- docpad.coffee |-- package.json
This is where the generated files are stored, once DocPad has been runned. However, this directory is unnecessary in versioning, so it is ignored (.gitignore).
Has all the images, CSS and JS files.
Contains some templates that are used in the application.
Stores most settings of the application.
List NodeJS modules dependencies.
We use a template engine called Eco (.eco), so you should definitely install a syntax highlight for it on your code editor.