Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update docs README with setup details #16352

Merged
merged 1 commit into from Sep 27, 2022
Merged

docs: update docs README with setup details #16352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/README.md
View file
Open in desktop
@@ -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