Skip to content

Commit 87718a5

Browse files
committed
chore(docs): update README docs on formatting and linting
1 parent e864021 commit 87718a5

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

packages/docs/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,25 @@ This command generates static content into the `build` directory and can be serv
3333
npm run serve
3434
```
3535

36-
The build folder is now served at http://localhost:3000/.
36+
The build folder is now served at http://localhost:3000/
3737

38-
## Linting
38+
## Formatting and linting
3939

4040
```bash
4141
# check formatting:
4242
npm run format:check
4343
# fix formatting:
4444
npm run format
45+
# check linting:
46+
npm run lint
47+
# fix linting:
48+
npm run lint:fix
4549
```
4650

51+
Prettier is used for formatting JavaScript files (the `format` script).
52+
53+
ESlint is used for linting `.md` and `.mdx` files due to poor support for these in Prettier (the `lint` script).
54+
4755
## Generating reference docs
4856

4957
The API reference pages are auto-generated from the Blockly TypeScript source using `@microsoft/api-extractor` and `@microsoft/api-documenter`. This is a separate step from the Docusaurus build and must be run from the `packages/blockly` directory:

0 commit comments

Comments
 (0)