chenglou/react-dash

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

React Dash Documentation

Warning!

React docset is now officially maintained by Dash and is avaiable since Dash 3.1.0. There's no need for this library anymore. Thus, it's now deprecated!

Below is the old instruction.

===

If you're looking for React documentations for Dash: they're already in Preferences -> Downloads -> User Contributed. This repo is used to generate those docs. You don't need to touch it unless you want to contribute to it.

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

react-dash's Issues

react-dash/src/index.js:26

react-dash/src/index.js:26

searchIndex.sync().success(function() {
^
TypeError: Object [object Promise] has no method 'success'

React Version 0.12.2 is Available

Thanks for your hard work. It is much appreciated.

Something error on runing build.sh

Looks like can't find this file react-dash/src/../Contents/Resources/Documents/react/docs/class-name-manipulation.html'

Converting facebook.github.io/react/css/codemirror.css... nothing to do.
Converted 175 files in 0.2 seconds.
fs.js:549
  return binding.open(pathModule._makeLong(path), stringToFlags(flags), mode);
                 ^

Error: ENOENT: no such file or directory, open '/Users/mc-zone/_dev/react-dash/src/../Contents/Resources/Documents/react/docs/class-name-manipulation.html'
    at Error (native)
    at Object.fs.openSync (fs.js:549:18)
    at Object.fs.readFileSync (fs.js:397:15)
    at /Users/mc-zone/_dev/react-dash/src/modifyDocsHTML.js:10:16
    at Array.forEach (native)
    at Object.<anonymous> (/Users/mc-zone/_dev/react-dash/src/modifyDocsHTML.js:7:14)
    at Module._compile (module.js:435:26)
    at Object.Module._extensions..js (module.js:442:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:311:12)
Executing (default): CREATE TABLE IF NOT EXISTS `searchIndex` (`id` INTEGER, `name` VARCHAR(255), `type` VARCHAR(255), `path` VARCHAR(255));
Executing (default): PRAGMA INDEX_LIST(`searchIndex`)
Executing (default): PRAGMA INDEX_INFO(`anchor`)
Unhandled rejection Error: ENOENT: no such file or directory, open '/Users/mc-zone/_dev/react-dash/src/../Contents/Resources/Documents/react/docs/class-name-manipulation.html'
    at Error (native)
    at Object.fs.openSync (fs.js:549:18)
    at Object.fs.readFileSync (fs.js:397:15)
    at /Users/mc-zone/_dev/react-dash/src/getData.js:12:18
    at Array.map (native)
    at getData (/Users/mc-zone/_dev/react-dash/src/getData.js:9:26)
    at /Users/mc-zone/_dev/react-dash/src/index.js:27:3
    at tryCatcher (/Users/mc-zone/_dev/react-dash/node_modules/sequelize/node_modules/bluebird/js/main/util.js:26:23)
    at Promise._settlePromiseFromHandler (/Users/mc-zone/_dev/react-dash/node_modules/sequelize/node_modules/bluebird/js/main/promise.js:503:31)
    at Promise._settlePromiseAt (/Users/mc-zone/_dev/react-dash/node_modules/sequelize/node_modules/bluebird/js/main/promise.js:577:18)
    at Promise._settlePromises (/Users/mc-zone/_dev/react-dash/node_modules/sequelize/node_modules/bluebird/js/main/promise.js:693:14)
    at Async._drainQueue (/Users/mc-zone/_dev/react-dash/node_modules/sequelize/node_modules/bluebird/js/main/async.js:123:16)
    at Async._drainQueues (/Users/mc-zone/_dev/react-dash/node_modules/sequelize/node_modules/bluebird/js/main/async.js:133:10)
    at Immediate.Async.drainQueues [as _onImmediate] (/Users/mc-zone/_dev/react-dash/node_modules/sequelize/node_modules/bluebird/js/main/async.js:15:14)
    at processImmediate [as _immediateCallback] (timers.js:368:17)

error

error info:

Any reason you don't publish to the official docs list?

The title is the question. Just wondering why you haven't added this docset to the official docs list. It would be a great addition.

Please update react-dash to version 0.13.1

There are many differences between 0.12.2 and 0.13.1.
Please update react-dash to 0.13.1

"Official" React docset

Hi @chenglou. This is just a heads-up that a React docset made by me will be released in the next Dash update. Please let me know what you would like to happen with your React docset in the user contributed section? Should I remove it or will you continue to support it alongside my own docset? Either way is fine with me.

If you want to check out my own docset, you can grab it from http://kapeli.com/feeds/React.tgz. Let me know if you have any comments or notice anything wrong.

Error: Cannot find module 'cheerio'

Getting this when running ./build.sh

module.js:340
    throw err;
          ^
Error: Cannot find module 'cheerio'
    at Function.Module._resolveFilename (module.js:338:15)
    at Function.Module._load (module.js:280:25)
    at Module.require (module.js:364:17)
    at require (module.js:380:17)
    at Object.<anonymous> (/Users/ilyo/dev/react-dash/src/modifyDocsHTML.js:1:77)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)

Please update and support ReactJS 0.12

Thanks for the great work!