TopCoat Organization
Watch this screencast.
-
Clone the repo locally:
git clone [email protected]:topcoat/topcoat.github.com.git
-
Install DocPad (make sure you have node and npm installed):
npm install -g docpad
-
Install all the docpad plugins (configuration located in the
package.json
file):npm install
-
You can start up docpad to test out your changes locally:
docpad run
-
Open your browser and go to http://localhost:9778/
- Live reload is enabled, so while you are making changes and saving the files, the browser should update automatically.
- To stop docpad hit
⌃ + c
-
Make changes only to the
src/
directory, everything else could be overwritten later.- All the dynamic content (jade, stylus, md, etc) is in
src/documents/
, the templates are insrc/layouts/
, and static files (images, etc) are insrc/static
. - While docpad is running locally, it will output the files to the
out/
directory
- All the dynamic content (jade, stylus, md, etc) is in
-
When you finish making changes, stop docpad (
⌃ + c
), and generate the static site:docpad generate --env static
-
Deploy to git:
git status
(to check your changes)
git commit -am 'type some descriptive message here