Merge pull request bids-standard#4 from bids-standard/master

update 10/24

.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/python:3.6.6
+    steps:
+      - checkout
+      - run: sudo chown -R circleci:circleci /usr/local/bin
+      - run: sudo chown -R circleci:circleci /usr/local/lib/python3.6/site-packages
+      - restore_cache:  # ensure this step occurs *before* installing dependencies
+          key: deps9-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+      - run:
+          command: |
+            sudo pip install pipenv==2018.7.1
+            pipenv install
+      - save_cache:
+          key: deps9-{{ .Branch }}-{{ checksum "Pipfile.lock" }}
+          paths:
+            - ".venv"
+            - "/usr/local/bin"
+            - "/usr/local/lib/python3.6/site-packages"
+      - run:
+          name: generate docs
+          command: pipenv run mkdocs build --clean --strict --verbose
+      - store_artifacts:
+          path: site

.gitignore

@@ -0,0 +1 @@
+site/

Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+mkdocs = "==1.0.4"
+mkdocs-material = "==3.0.4"
+
+[dev-packages]
+
+[requires]
+python_version = "3.6"

mkdocs.yml

@@ -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

readthedocs.yml

@@ -0,0 +1,5 @@
+build:
+  image: latest
+
+python:
+  version: 3.6

requirements.txt

@@ -0,0 +1 @@
+mkdocs-material

src/index.md

@@ -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.md). 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).