gocodebox / LifterLMS-Dash-Docset

LifterLMS Dash Docset

A docset of LifterLMS for the Mac OS X app Dash.

Manual Installation

1. Download and extract the Zip of this repository.
2. Open Dash
3. Double Click "LifterLMS.docset"

Install for Docset Generation

1. Clone this repo and cd into the directory.
2. Install node dependencies: npm install
3. Install Dashing: brew install dashing

Generate the Docset

1. Scrape the docs from https://developer.lifterlms.com: npm run scrape (this takes a while)
2. Generate the docset with Dashing: npm run generate

Contribute the Docset to Dash User Contributions

1. Bump the package version (use npm version {version}), commit and push the changes.
2. Sync the fork, add new docs to fork, push changes: ./push.sh
3. Open a PR in the upstream repo: https://github.com/Kapeli/Dash-User-Contributions/compare/master...gocodebox:master