Note - This is an effort to make a vanilla version of CFPB's outstanding API documentation. Though many of the references to the agency (and it's HMDA system) have been genericized, a number remain. In particular, the Basics, Console, and Queries page have mostly been kept intact in order to show how those pages can work. An agency re-using this would need to fully migrate that material to fit their API. One will also need to review the setup for the 'Fields` page in order to have it populate like it does on the CFPB instance.
This is the documentation repository for the [System] dataset. Check out this API documentation at http://usg-website-templates.github.io/developer-hub/.
Thanks to the CFPB eRegs and HMDA teams and their documentation work for starting us off with a great codebase.
You can use DOCter to build documentation sites similar to this one.
If you are going to work on the JavaScript for this site, you need to do the following:
- Run
npm install -g bowerto install Bower. - Run
npm install -g grunt-clito install Grunt. - Run
npm installin the directory to install other tools. - Run
bower installto install dependencies.
After changing the JavaScript, run grunt to rebuild the minified JS.
In order to have the local resources work for both a github pages organizational and a project type site, pass a baseurl parameter at jekyll startup.
bundle exec jekyll server --watch --baseurl ''