Table of contents
How it works?
We use Docpad, a static generator in NodeJS.
Install NodeJS, if you don't have it yet.
Install Docpad globally:
[sudo] npm install -fg docpad
Install Yogi Alloy globally:
[sudo] npm -g install yogi yogi-alloy
Once you have dependencies installed, you just need to:
Clone the project:
git clone email@example.com:liferay/alloyui.com.git
Then go to the project's folder:
And finally run:
yogi alloy --site-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.
Go to the branch you want to deploy and run
yogi alloy --site-deploy, now you can see your changes live at alloyui.com.
Note: Make sure to commit everything before running this command.
We use a template engine called Eco (.eco), so you should definitely install a syntax highlight for it on your code editor.