We've used VuePress to generate the documentation for Puppet WP.
You can contribute updates to the documentation on any page by clicking on the
Suggest an edit! links in the footer
of any of the pages.
The title, navigation, sidebar and repository links are all managed in
If you'd like to contribute and preview your contributions before you submit a Pull Request to Puppet WP you can do the following:
- Clone the repository to your computer:
git clone https://github.com/Chassis/puppet-wp <your-folder>
cd docsin a terminal.
yarn docs:devand open http://localhost:8080/ in a browser.
yarn docs:buildto build static assets.
GITHUB_TOKEN is a personal access token which can be created on Github. Once created, this token should be copied into the Environmental Variables settings on TravisCI.