README.md

PGBR 2015 WebSite

How it works?

The website is generated based on template files and the main configuration file docpad.coffee.

Learn more about conf-boilerplate and docpad to know how it works.

Getting Started

1. Install Git and NodeJS, if you don't have it yet.

2. Clone it:

git clone [email protected]:pgbr/www-2015.git

3. Install project dependencies

npm install

4. Run the project

npm run-script docpad run

Structure

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

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

docpad.coffee

This is the main file configuration. All basic site information is set here. You can also edit template and assets files to change anything that you can on website.

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

See also

There are many more useful commands from docpad you might want to use.

All of them can be called using the shortcut npm run-script docpad

Sample:

• npm run-script docpad run - Starts the http server and watch any changes to re-generate the website on the fly. Very useful when creating the website.
• npm run-script docpad clean - Cleanup all output folders.
• npm run-script docpad generate - Generate the website.

Run npm run-script docpad help to see more.

Deploy

Github

If you use github and would like to see your website running, please use the publish.sh. It will automatically checkout the gh-pages branch and generate and push a new version of the website.

PS: The gh-pages branch must exist previously to work properly.

Outsite of github

Just run npm run-script docpad generate then just publish the out folder to any host of your choice.

License

The MIT License (MIT)