add CI for dead links and markdown linter

.all-contributorsrc

@@ -2,6 +2,7 @@
   "files": [
     "README.md"
   ],
+  "contributorsSortAlphabetically": true,
   "imageSize": 100,
   "commit": false,
   "contributors": [

.github/workflows/check_md_links.yml

@@ -0,0 +1,12 @@
+name: Check Markdown links
+
+# checking for any dead links in markdown files
+
+on: push
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1

.prettierrc

@@ -0,0 +1,13 @@
+{
+  "parser": "markdown",
+  "proseWrap": "always",
+  "tabWidth": 2,
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "tabWidth": 4
+      }
+    }
+  ]
+}

.remarkrc

@@ -0,0 +1,11 @@
+{
+  "plugins": [
+    "preset-lint-consistent",
+    "preset-lint-markdown-style-guide",
+    "preset-lint-recommended",
+    ["lint-no-duplicate-headings", false],
+    ["lint-list-item-indent", "tab-size"],
+    ["lint-maximum-line-length", true],
+    ["lint-maximum-heading-length", false]
+  ]
+}

.travis.yml

@@ -12,42 +12,67 @@ python:
 
 cache:
   apt: true # only works with Pro version
+  directories:
+  - node_modules # NPM packages for the remark markdown linter
+
+branches:
+  only:  # only run the CI for those branches 
+  - master
+  - dev
 
 env:
   global:
     - OCTFLAGS="--no-gui --no-window-system --silent"
 
-before_install:
-  # install octave
-  - travis_retry sudo apt-get -y -qq update
-  - travis_retry sudo apt-get -y install octave
-  - travis_retry sudo apt-get -y install liboctave-dev
-  # install MOX unit
-  - git clone https://github.com/MOxUnit/MOxUnit.git --depth 1
-  - cd MOxUnit
-  - make install
-  - cd ..
-  # install MOcov
-  - git clone https://github.com/MOcov/MOcov.git  --depth 1
-  - cd MOcov
-  - make install
-  - cd ..
-  # install SPM and the relevant patches for octave
-  - git clone https://github.com/spm/spm12.git --depth 1
-  - make -C spm12/src PLATFORM=octave distclean
-  - make -C spm12/src PLATFORM=octave
-  - make -C spm12/src PLATFORM=octave install
-  # get data
-  - mkdir demo/output
-  - curl http://www.fil.ion.ucl.ac.uk/spm/download/data/MoAEpilot/MoAEpilot.bids.zip --output demo/output/MoAEpilot.zip
-  - unzip demo/output/MoAEpilot.zip -d demo/output/
-
-
-script:
-  - octave $OCTFLAGS --eval "runTests"
-  - cat test_report.log | grep 0
-
-after_success:
-  - bash <(curl -s https://codecov.io/bash)
+jobs:
+
+  include:
+
+    # naming the Tests stage
+    - stage: "Unit tests and coverage" 
+      # names the first job
+      name: "Unit tests and coverage" 
+
+      before_install:
+        # install octave
+        - travis_retry sudo apt-get -y -qq update
+        - travis_retry sudo apt-get -y install octave
+        - travis_retry sudo apt-get -y install liboctave-dev
+        # install MOX unit
+        - git clone https://github.com/MOxUnit/MOxUnit.git --depth 1
+        - cd MOxUnit
+        - make install
+        - cd ..
+        # install MOcov
+        - git clone https://github.com/MOcov/MOcov.git  --depth 1
+        - cd MOcov
+        - make install
+        - cd ..
+        # install SPM and the relevant patches for octave
+        - git clone https://github.com/spm/spm12.git --depth 1
+        - make -C spm12/src PLATFORM=octave distclean
+        - make -C spm12/src PLATFORM=octave
+        - make -C spm12/src PLATFORM=octave install
+        # get data
+        - mkdir demo/output
+        - curl http://www.fil.ion.ucl.ac.uk/spm/download/data/MoAEpilot/MoAEpilot.bids.zip --output demo/output/MoAEpilot.zip
+        - unzip demo/output/MoAEpilot.zip -d demo/output/
+
+      script:
+        - octave $OCTFLAGS --eval "runTests"
+        - cat test_report.log | grep 0
 
+      # to send the results to codecov to get our code coverage
+      after_success:
+        - bash <(curl -s https://codecov.io/bash) 
 
+    # naming the Linter stage
+    - stage: Markdown linter
+      name: "Check markdown"
+      language: node_js
+      node_js:
+        - "10"
+      before_script:
+        - npm install `cat npm-requirements.txt`
+      script:
+        - remark . --frail