Skip to content

Commit 0642bb7

Browse files
authored
Refactor README.md section headers for clarity
Updated section headers to remove special characters and improve formatting.
1 parent 8b90a9d commit 0642bb7

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ npm install
2525

2626
## Linting
2727

28-
### Linting TypeScript
28+
### Linting TypeScript
2929

3030
```shell
3131
npm run lint:ts
@@ -34,7 +34,7 @@ npm run lint:ts
3434
`npm run lint:ts` will lint the TypeScript source code using ESLint, identifying syntactic and stylistic errors based on a configured set of rules.
3535
TypeScript linting configurations and rules can be found, edited, and updated in `eslint.config.ts.mjs`.
3636

37-
### Linting JavaScript
37+
### Linting JavaScript
3838

3939
```shell
4040
npm run lint:js
@@ -45,7 +45,7 @@ JavaScript linting configurations and rules can be found, edited, and updated in
4545

4646
## Building
4747

48-
### Development Mode
48+
### Development Mode
4949

5050
```shell
5151
npm run build:dev
@@ -55,7 +55,7 @@ npm run build:dev
5555
This should identify any compiler errors present in your source code.
5656
The webpack build configuration can be found in `webpack.config.cjs`.
5757

58-
### Production Mode
58+
### Production Mode
5959

6060
```shell
6161
npm run build:prod
@@ -64,7 +64,7 @@ npm run build:prod
6464
`npm run build:prod` will bundle your sketch in production mode using webpack.
6565
The webpack build configuration can be found in `webpack.config.cjs`.
6666

67-
### Development Mode with Single File Output
67+
### Development Mode with Single File Output
6868

6969
```shell
7070
npm run build:dev:single-file
@@ -75,7 +75,7 @@ The resulting bundle will have your source code and all its dependencies in a si
7575
This should identify any compiler errors present in your source code.
7676
The webpack build configuration can be found in `webpack.single-file.config.cjs`.
7777

78-
### Production Mode with Single File Output
78+
### Production Mode with Single File Output
7979

8080
```shell
8181
npm run build:prod:single-file
@@ -87,31 +87,31 @@ The webpack build configuration can be found in `webpack.single-file.config.cjs`
8787

8888
## Serving
8989

90-
### Serving the Development Bundle
90+
### Serving the Development Bundle
9191

9292
```shell
9393
npm run dev
9494
```
9595

9696
`npm run dev` will bundle the sketch in development mode, start a localhost development server (`127.0.0.1:8080`), and open a new browser window for the `index.html` file bundled with the compiled sketch.
9797

98-
### Serving the Development Bundle with Single File Output
98+
### Serving the Development Bundle with Single File Output
9999

100100
```shell
101101
npm run dev:single-file
102102
```
103103

104104
`npm run dev:single-file` will bundle the sketch in development mode with `webpack.single-file.config.cjs`, start a localhost development server (`127.0.0.1:8080`), and open a new browser window for the `index.html` file bundled with the compiled sketch.
105105

106-
### Serving the Production Bundle
106+
### Serving the Production Bundle
107107

108108
```shell
109109
npm run dev:prod
110110
```
111111

112112
`npm run dev:prod` will bundle the sketch in production mode, start a localhost development server (`127.0.0.1:8080`), and open a new browser window for the `index.html` file bundled with the compiled sketch.
113113

114-
### Serving the Production Bundle with Single File Output
114+
### Serving the Production Bundle with Single File Output
115115

116116
```shell
117117
npm run dev:prod:single-file

0 commit comments

Comments
 (0)