Mangrove Playbook's Website, built with DocPad
-
Clone the playbook website
git clone https://github.com/meetmangrove/playbook-website.git playbook-website cd playbook-website
-
Install the website's dependencies
npm install
-
Start the development server:
npm start
-
Start hacking away by modifying the
docpad.js
file and thesrc
directory
A lot of the structure (like the menu listings and documentation page layouts) is provided by bevry/outpatient. To make changes to this:
-
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
-
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 uses hyperscript as its rendering engine.
To deploy to surge.sh:
npm test # to generate the site
npm run deploy # to deploy the site
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.
Unless stated otherwise all works are:
- Copyright © Mangrove
and licensed under: