Skip to content

Commit

Permalink
Clarify where docs live
Browse files Browse the repository at this point in the history
  • Loading branch information
gaearon committed May 1, 2017
1 parent f737d63 commit f217228
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# React Documentation & Website

We use [Jekyll](http://jekyllrb.com/) to build the site using ([mostly](http://zpao.com/posts/adding-line-highlights-to-markdown-code-fences/)) Markdown, and we host it by pushing HTML to [GitHub Pages](http://pages.github.com/).
## [Read the React Documentation](https://facebook.github.io/react/)

This folder is not the right place to *read* the documentation.

Instead, head over [to the React website](https://facebook.github.io/react/) to read it.

This folder only contains the source code for the website.

## Installation

If you are working on the site, you will want to install and run a local copy of it.

We use [Jekyll](http://jekyllrb.com/) to build the site using ([mostly](http://zpao.com/posts/adding-line-highlights-to-markdown-code-fences/)) Markdown, and we host it by pushing HTML to [GitHub Pages](http://pages.github.com/).

### Dependencies

In order to use Jekyll, you will need to have Ruby installed. macOS comes pre-installed with Ruby, but you may need to update RubyGems (via `gem update --system`).
Expand Down

0 comments on commit f217228

Please sign in to comment.