-
Notifications
You must be signed in to change notification settings - Fork 161
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #42 from choldgraf/mkdocs
Mkdocs configuration and RTD setup
- Loading branch information
Showing
5 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
site/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
site_name: Brain Imaging Data Structure | ||
theme: material | ||
plugins: | ||
- search | ||
docs_dir: 'src' | ||
use_directory_urls: false | ||
nav: | ||
- The BIDS Specification: | ||
- Introduction: 01-introduction.md | ||
- Common principles: 02-common-principles.md | ||
- Modality agnostic files: 03-modality-agnostic-files.md | ||
- Modality specific files: | ||
- Magnetic Resonance Imaging: 04-modality-specific-files/01-magnetic-resonance-imaging-data.md | ||
- Magnetoencephalography: 04-modality-specific-files/02-magnetoencephalography.md | ||
- Task events: 04-modality-specific-files/03-task-events.md | ||
- Physiological and other continous recordings: 04-modality-specific-files/04-physiological-and-other-continous-recordings.md | ||
- Behavioral experiments (with no MRI): 04-modality-specific-files/05-behavioural-experiments.md | ||
- Longitudinal and multi-site studies: 05-longitudinal-and-multi-site-studies.md | ||
- The BIDS Starter Kit: https://github.com/bids-standard/bids-starter-kit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
build: | ||
image: latest | ||
|
||
python: | ||
version: 3.6 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
mkdocs-material |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# The Brain Imaging Data Structure | ||
|
||
This site serves as an online resource to see the current state of the | ||
Brain Imaging Data Structure (BIDS) specification. It contains information | ||
about the core specification, as well as many modality-specific extensions. | ||
|
||
To get started, [check out the introduction](01-introduction). If you'd like | ||
more information on how to adapt your own datasets to match the BIDS | ||
specification, we recommend exploring the [bids-specification starter kit](https://github.com/bids-standard/bids-starter-kit). |