Skip to content
Website for AlloyUI
HTML JavaScript CSS
Find file
Latest commit 8a1643d @zenorocha zenorocha Bump version

README.md

AlloyUI.com

Build Status Dependencies Status

AlloyUI Robo Suit

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.

Table of contents

How it works?

We use DocPad, a static generator in NodeJS.

Dependencies

Install Node.JS, if you don't have it yet.

Getting started

Once you have dependencies installed, you just need to:

  1. Clone the project: git clone git@github.com: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

Structure

The basic structure of the project is given in the following way:

.
|-- out/
|-- src/
|   |-- documents/
|   |-- files/
|   |-- layouts/
|-- docpad.coffee
|-- package.json

out/

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).

src/documents/

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

src/files/

Has all the images, CSS and JS files.

src/layouts/

Contains some templates that are used in the application.

docpad.js

Stores most settings of the application.

package.json

List NodeJS modules dependencies.

Bonus

We use a template engine called Eco (.eco), so you should definitely install a syntax highlight for it on your code editor.

Something went wrong with that request. Please try again.