If you want to report an issue about AlloyUI's website you are in the right place. But if you're facing problems with AlloyUI's source code, please visit liferay/alloy-ui repository.

• How it works?
• Dependencies
• Getting started
• Structure
• Bonus

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:

1. Clone the project: git clone [email protected]:liferay/alloyui.com.git

2. Then go to the project's folder: cd alloyui.com

3. Install the dependencies: npm install

4. And finally run: npm run watch

Now you can see the website running in http://localhost:9778/ :D

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 ran. However, this directory is unnecessary in versioning, so it is ignored (.gitignore).

Contains all the pages of this website. Documentation is written in Markdown and examples in JavaScript.

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.