From 4b81486641f2ad5eb6d956be70b633e1716078da Mon Sep 17 00:00:00 2001 From: Ben Perlmutter Date: Mon, 26 Sep 2022 20:26:07 -0400 Subject: [PATCH] update docs README w setup details --- docs/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/README.md b/docs/README.md index ee5f64e100ec..140608aa2d22 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,11 +1,25 @@ # ESLint Documentation +## Install Dependencies + +Install the necessary dependencies for the documentation site by running this +from the `docs` folder: + +```shell +npm install +``` + ## Run Locally +Run this from the `docs` folder: + ```shell npm start ``` +Once the script finishes building the documentation site, you can visit it at +. + ## Scripts To update the links data file, run this from the root folder (not the `docs` folder):