From 42ce5d992affaa056a6c2f8862f0cfa9354cefaa Mon Sep 17 00:00:00 2001 From: Pascal Hartig Date: Wed, 5 Sep 2018 07:57:51 -0700 Subject: [PATCH] Add docusaurus note to README Summary: Took me a moment to figure out how to build it, so let's add it to the docs. Reviewed By: jknoxville Differential Revision: D9654631 fbshipit-source-id: 32ee6e647d9fa85b921d19919c1bbd060615bb8e --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 91b0702a3..9e35a42f0 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,15 @@ Start up an android emulator and run the following in the project root: Find the full documentation for this project at [fbflipper.com](https://fbflipper.com/docs). +Our documentation is built with [Docusaurus](https://docusaurus.io/). You can build +it locally by running this: + +```bash +cd website +yarn +yarn start +``` + ## Contributing See the [CONTRIBUTING](/CONTRIBUTING.md) file for how to help out.