From f6d57fb657c2f4e8e0140ad057da34c935482972 Mon Sep 17 00:00:00 2001 From: Ben Perlmutter <57849986+bpmutter@users.noreply.github.com> Date: Tue, 27 Sep 2022 04:05:41 -0400 Subject: [PATCH] docs: Update docs README (#16352) Add more detailed setup information to the docs README. --- docs/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/README.md b/docs/README.md index ee5f64e100e..140608aa2d2 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):