Dan Abramov
80b862395d
* Add missing object-assign dep to create-react-class * Remove unnecessary inlines and irrelevant tests in createFragment * Uninline shallowEqual in shallowCompare * Uninline invariant in update * Uninline invariant/warning and remove unreachable code in react-linked-input * Envify and collapse createClass UMD * Envify and collapse createFragment * ReactLink doesn't really need PropTypes dep It is unnecessary because it is not explicitly exposed and was never public API. * Rebuild, envify and collapse LinkedStateMixin UMD * Collapse PureRenderMixin UMD * Rebuild shallowCompare * Envify and collapse update UMD * Remove unused prop-types dep from linked-input * Fix change handling in LinkedInput * Compile LinkedInput to ES5 * Rebuild, collapse, and fix LinkedInput UMD * Add full README for react-addons-create-fragment * Mention compat version of transition-group so we can delete those docs * README for react-addons-linked-state-mixin * More docs * Fix devDeps for createClass * docs
React Documentation & Website
We use Jekyll to build the site using (mostly) Markdown, and we host it by pushing HTML to GitHub Pages.
Installation
If you are working on the site, you will want to install and run a local copy of it.
Dependencies
In order to use Jekyll, you will need to have Ruby installed.
Mac OS X comes pre-installed with Ruby, but you may need to update RubyGems (via gem update --system).
Otherwise, RVM and rbenv are popular ways to install Ruby.
Once you have RubyGems and installed Bundler (via gem install bundler), use it to install the dependencies:
$ cd react/docs
$ bundle install # Might need sudo.
$ npm install
Instructions
The site requires React, so first make sure you've built the project (via grunt).
Use Jekyll to serve the website locally (by default, at http://localhost:4000):
$ cd react/docs
$ bundle exec rake
$ bundle exec jekyll serve -w
$ open http://localhost:4000/react/index.html
We use SASS (with Bourbon) for our CSS, and we use JSX to transform some of our JS. If you only want to modify the HTML or Markdown, you do not have to do anything because we package pre-compiled copies of the CSS and JS. If you want to modify the CSS or JS, use Rake to compile them:
$ cd react/docs
$ bundle exec rake watch # Automatically compiles as needed.
# bundle exec rake Manually compile CSS and JS.
# bundle exec rake js Manually compile JS, only.
Afterthoughts
Updating facebook.github.io/react
The easiest way to do this is to have a separate clone of this repository, checked out to the gh-pages branch. We have a build step that expects this to be in a directory named react-gh-pages at the same depth as react. Then it's just a matter of running grunt docs, which will compile the site and copy it out to this repository. From there, you can check it in.
Note: This should only be done for new releases. You should create a tag corresponding to the release tag in the main repository.
We also have a rake task that does the same thing (without creating commits). It expects the directory structure mentioned above.
$ bundle exec rake release
Removing the Jekyll / Ruby Dependency
In an ideal world, we would not be adding a Ruby dependency on part of our project. We would like to move towards a point where we are using React to render the website.