From f217228326952d1f138cd49001cc458a0ec2a825 Mon Sep 17 00:00:00 2001 From: Dan Abramov Date: Mon, 1 May 2017 13:39:10 +0100 Subject: [PATCH] Clarify where docs live --- docs/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 6517ab8bb4..938e0d2c8d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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`).