You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/docs/README.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,17 +33,25 @@ This command generates static content into the `build` directory and can be serv
33
33
npm run serve
34
34
```
35
35
36
-
The build folder is now served at http://localhost:3000/.
36
+
The build folder is now served at http://localhost:3000/
37
37
38
-
## Linting
38
+
## Formatting and linting
39
39
40
40
```bash
41
41
# check formatting:
42
42
npm run format:check
43
43
# fix formatting:
44
44
npm run format
45
+
# check linting:
46
+
npm run lint
47
+
# fix linting:
48
+
npm run lint:fix
45
49
```
46
50
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
+
47
55
## Generating reference docs
48
56
49
57
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