Skip to content

Commit

Permalink
Merge pull request #42 from choldgraf/mkdocs
Browse files Browse the repository at this point in the history
Mkdocs configuration and RTD setup
  • Loading branch information
chrisgorgo authored Oct 12, 2018
2 parents 1af72ad + ba72381 commit 20ef76e
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site/
19 changes: 19 additions & 0 deletions mkdocs.yml
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
5 changes: 5 additions & 0 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
build:
image: latest

python:
version: 3.6
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs-material
9 changes: 9 additions & 0 deletions src/index.md
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).

0 comments on commit 20ef76e

Please sign in to comment.