Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
docs: Update docs README (#16352)
Add more detailed setup information to the docs README.
  • Loading branch information
bpmutter committed Sep 27, 2022
1 parent e5e9e27 commit f6d57fb
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions 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
<http://localhost:2023>.

## Scripts

To update the links data file, run this from the root folder (not the `docs` folder):
Expand Down

0 comments on commit f6d57fb

Please sign in to comment.