Documentation
VuePress
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.
VuePress Configuration
The title, navigation, sidebar and repository links are all managed in docs/.vuepress/config.js
.
Documentation Installation
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>
- Run
cd docs
in a terminal. - Run
yarn install
- Run
yarn docs:dev
and open http://localhost:8080/ in a browser. - Run
yarn docs:build
to build static assets.
Documentation Deployment
The documentation is hosted on Github Pages and this is automatically deployed with TravisCI.
The 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.
← User Puppet Forge →