Skip to content

Commit b1d43aa

Browse files
authored
Merge pull request #130 from effigies/doc/conform-readme
doc: Conform README and docs/index
2 parents 6eceef3 + dda32ef commit b1d43aa

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77

88
The BIDS Validator is a web application, command-line utility,
99
and Javascript/Typescript library for assessing compliance with the
10-
[Brain Imaging Data Structure (BIDS)](https://bids.neuroimaging.io/) standard.
10+
[Brain Imaging Data Structure (BIDS)][BIDS] standard.
1111

1212
## Getting Started
1313

1414
In most cases,
15-
the simplest way to use the validator is to browse to the [BIDS Validator][https://bids-standard.github.io/bids-validator/] web page:
15+
the simplest way to use the validator is to browse to the [BIDS Validator][] web page:
1616

1717
![The web interface to the BIDS Validator with the "Select Dataset Files" button highlighted.
1818
(Dark theme)](docs/_static/web_entrypoint_dark.png#gh-dark-mode-only)
@@ -23,8 +23,8 @@ The web validator runs in-browser, and does not transfer data to any remote serv
2323

2424
In some contexts, such as when working on a remote server,
2525
it may be easier to use the command-line.
26-
The BIDS Validator can be run with the [Deno](https://deno.com/) runtime
27-
(see [Deno - Installation](https://docs.deno.com/runtime/getting_started/installation/) for detailed installation instructions):
26+
The BIDS Validator can be run with the [Deno][] runtime
27+
(see [Deno - Installation][] for detailed installation instructions):
2828

2929
```shell
3030
deno run -ERN jsr:@bids/validator
@@ -86,3 +86,8 @@ The command to compile a dereferenced schema is `bst -v export --schema src/sche
8686
## Documentation
8787

8888
The BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).
89+
90+
[BIDS]: https://bids.neuroimaging.io
91+
[BIDS Validator]: https://bids-standard.github.io/bids-validator/
92+
[Deno]: https://deno.com/
93+
[Deno - Installation]: https://docs.deno.com/runtime/getting_started/installation/

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The BIDS Validator is a web application, command-line utility,
44
and Javascript/Typescript library for assessing compliance with the
5-
[Brain Imaging Data Structure][BIDS] standard.
5+
[Brain Imaging Data Structure (BIDS)][BIDS] standard.
66

77
## Getting Started
88

@@ -18,7 +18,7 @@ The web validator runs in-browser, and does not transfer data to any remote serv
1818

1919
In some contexts, such as when working on a remote server,
2020
it may be easier to use the command-line.
21-
The BIDS Validator can be run with the [Deno] runtime
21+
The BIDS Validator can be run with the [Deno][] runtime
2222
(see [Deno - Installation][] for detailed installation instructions):
2323

2424
```shell

0 commit comments

Comments
 (0)