Skip to content

Commit f6d57fb

Browse files
authored
docs: Update docs README (#16352)
Add more detailed setup information to the docs README.
1 parent e5e9e27 commit f6d57fb

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

docs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
11
# ESLint Documentation
22

3+
## Install Dependencies
4+
5+
Install the necessary dependencies for the documentation site by running this
6+
from the `docs` folder:
7+
8+
```shell
9+
npm install
10+
```
11+
312
## Run Locally
413

14+
Run this from the `docs` folder:
15+
516
```shell
617
npm start
718
```
819

20+
Once the script finishes building the documentation site, you can visit it at
21+
<http://localhost:2023>.
22+
923
## Scripts
1024

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

0 commit comments

Comments
 (0)