Contribute
Last updated
Was this helpful?
Last updated
Was this helpful?
For the most part, DocPad inherits from the , with the following exceptions.
To get started with developing and contributing code, you must first setup your project for development.
To setup a development environment for contributing to the DocPad core follow these steps:
Fork the repository of the DocPad Core:
Clone your fork to your machine then cd into it
Run npm run prepare to install any missing dependencies
Run npm run compile to compile the project
Run npm test to test the project
Run npm link to make this development instance of the projects available to other projects (via npm link docpad)
To setup a development environment for contributing to a plugin follow these steps:
Ensure you have DocPad setup for development, by running the DocPad core instructions above
Fork the repository of the DocPad plugin you wish to edit
Clone your fork to your machine then cd into it
Run npm link docpad to link our local development instance of DocPad that we setup earlier to our DocPad plugin
Run cake install to install any missing dependencies
Run cake compile to compile the project
Run cake test to test the project
Run npm link to make this development instance of the project available to other projects (via npm link docpad-plugin-PLUGINNAME)