mspangdal/react-dash

React documentation source for [Dash](http://kapeli.com/dash)

React Dash Documentation

This repo is used to generate the docs for Dash. To update the docset, please read the instructions here (more specifically, "Set up your directory structure"). To generate the docset for your Dash-User-Contributions pull quest, you'd use this repo.

Note: if you do wish to update the docset, please notify me by opening an issue. I'd like to double check everything before you send it off to the Dash repo.

Instructions

Prerequisites: wget, node and sqlite3. For OS X:

brew install wget node sqlite3

Clone this repo, cd into it and do:

npm install
chmod 777 build.sh
./build.sh

The script will:

• Fetch the newest released React documentation from http://facebook.github.io/react/.
• Parse the doc site into a new SQLite database for Dash. The list of files are hardcoded. Please check src/index.js for more detail.
• Bundle up the result in a React.docset.

Test the output by clicking on React.docset (importing it into Dash). Then, like it said on Dash User Contributions:

tar --exclude='.DS_Store' -cvzf React.tgz React.docset