@@ -196,7 +196,18 @@ cd bids-specification
196
196
197
197
Enter all commands below from the command line prompt located at the root of the local version of the specification.
198
198
199
- ### 3. Install MkDocs, the Material theme and the required extensions
199
+ ### 3. Prepare your virtual environment
200
+
201
+ The simplest way to prepare a Python environment for building the specification is
202
+ with [ uv] ( https://docs.astral.sh/uv/ ) .
203
+
204
+ ``` bash
205
+ uv sync
206
+ ```
207
+
208
+ (If you use ` uv run ` in the next section, this will be run implicitly.)
209
+
210
+ <details ><summary >Expand for detailed instructions that do not use `uv`.</summary >
200
211
201
212
In the following links, you can find more information about
202
213
@@ -252,13 +263,17 @@ This installs the `bidsschemacode` package in "editable" mode,
252
263
so that any changes you make to the code will be reflected when you use it,
253
264
such as when you build the documentation locally.
254
265
266
+ </details >
267
+
255
268
### 4. Ready to build!
256
269
257
- Using the terminal (command line) please enter ` mkdocs serve ` .
270
+ Using the terminal (command line) please enter ` uv run mkdocs serve` .
258
271
This will allow you to see a local version of the specification.
259
272
The local address will be ` http://127.0.0.1:8000 ` .
260
273
You may enter that into your browser and this will bring up the specification!
261
274
275
+ (If you are not using ` uv ` , activate your environment and then run ` mkdocs serve ` .)
276
+
262
277
## Fixing Markdown style errors
263
278
264
279
We use a linter called [ Remarkjs] ( https://github.com/remarkjs/remark-lint ) to
0 commit comments