Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 1.24 KB

Instructions.md

File metadata and controls

60 lines (36 loc) · 1.24 KB
Raw

Instructions

Requirements

Grunt

Install grunt after you've installed Node.

npm install -g grunt-cli

Quick Start

NOTE: For development, always work out of the "source" branch, never, ever touch "master".

  1. Clone the repo, install the dependencies, and start the preview server.

    git clone [email protected]:maxcdn/api-docs.git
npm install
./preview

  2. Visit http://localhost:8080/ in your browser.

  3. Make changes to ./Readme.md and refresh the page.

  4. You can also edit ./templates/layout.jade for HTML changes using the Jade template engine.

  1. Make CSS changes using LESS or plain CSS by editing files in the ./contents/css folder.

  2. Add images in the ./contents/img/ folder and fonts in the ./contents/font/ folder.

  3. When you're ready to deploy your changes:

    git add .
git commit -m 'I made some changes'
git push origin source
grunt

  4. This will automatically build the site, and then deploy it to the master branch.

Support

If you run into issues please contact [email protected] or [email protected]

License

MIT