Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
41 lines (26 sloc) 1.02 KB

WP MVC Doc

Documentation for WP MVC

Description

This documentation can be viewed here. It runs on JDoc.

Usage

Local Development

Install Jekyll, which is required by JDoc.

Clone the repo recursively:

git clone --recursive git://github.com/tombenner/wp-mvc-doc

And run Jekyll to build the site and start serving it:

jekyll serve

You may need to modify the baseurl value in _config.yml.

Deployment

wpmvc.org points to the this repo's GitHub Pages instance, so to deploy, you'll want create the static site, update the gh-pages branch with it, then push:

First, run Jekyll to create the static site in the _site directory:

jekyll serve

Copy the contents of the _site directory, check out the gh-pages branch, then paste the contents of the _site directory into the repo's root directory. Commit and push.