Mangrove Playbook's Website, built with DocPad

Getting Started

1. Clone the playbook website

   git clone https://github.com/meetmangrove/playbook-website.git playbook-website
   cd playbook-website

2. Install the website's dependencies

   npm install

3. Start the development server:

   npm start

4. Open http://localhost:9778/

5. Start hacking away by modifying the docpad.js file and the src directory

Editing Structure

A lot of the structure (like the menu listings and documentation page layouts) is provided by bevry/outpatient. To make changes to this:

1. Clone outpatient (or your fork), install its dependencies, and link it for development

   cd where/you/put/your/projects
   git clone https://github.com/bevry/outpatient.git
   cd outpatient
   npm install  # install its deps
   npm link  # link it for development

2. Then inside our website repo, tell it to use our local outpatient copy:

   cd where/you/put/playbook-website
   npm link outpatient  # pull in our local outpatient to use with the website
   npm start

Modifications to outpatient will require running npm start again. When you are ready to push your changes up, contact @balupton.

The files that probably interest you are:

• outpatient/source/documentation-layout.js
• outpatient/source/block.js
• outpatient/source/menu.js

Outpatient uses hyperscript as its rendering engine.

Deployment

To deploy to surge.sh:

npm test  # to generate the site
npm run deploy  # to deploy the site

Update the Content

The content is stored in a separate repository which is pulled into this website at run-time. You'll want to edit the documentation repo instead if you want to make changes to the documentation.

License

Unless stated otherwise all works are:

• Copyright © Mangrove

and licensed under:

• MIT License
• or
• Creative Commons Attribution 4.0