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: CONTRIBUTING.md
+3-2
Original file line number
Diff line number
Diff line change
@@ -165,15 +165,16 @@ Draft pull requests can still be reviewed while in draft state.
165
165
166
166
### Preview specification HTML locally
167
167
168
+
> [!NOTE]
169
+
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).
170
+
168
171
The markdown source files are converted to HTML before publishing.
169
172
To do this locally, please
170
173
171
174
1. Install [Node.js](https://nodejs.org/)
172
175
2. Check out this repo, go to the repo root, and switch to a development branch
173
176
3. Execute `npm install` (once, repeat after merging upstream changes)
174
177
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
175
-
> [!NOTE] Use Git Bash on Windows
176
-
> This npm script calls bash scripts. Run it from [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).
177
178
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
178
179
179
180
Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
0 commit comments