Merge pull request #81 from citation-file-format/markdown-link-check

Markdown link check

.github/workflows/markdown-link-checker.yml

@@ -0,0 +1,13 @@
+name: Check Markdown links
+
+on: [push, pull_request]
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        config-file: '.mlc-config.json'
+

.mlc-config.json

@@ -0,0 +1,11 @@
+{
+    "_comment": "Markdown Link Checker configuration, see https://github.com/gaurav-nelson/github-action-markdown-link-check and https://github.com/tcort/markdown-link-check",
+    "ignorePatterns": [
+    ],
+    "replacementPatterns": [
+        {
+            "pattern": "^/",
+            "replacement": "https://github.com/citation-file-format/cff-initializer-javascript/blob/master/"
+        }
+    ]
+}

README.md

@@ -1,19 +1,20 @@
 - [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1404735.svg)](https://doi.org/10.5281/zenodo.1404735)
 - [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcitation-file-format%2Fcff-initializer-javascript.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcitation-file-format%2Fcff-initializer-javascript?ref=badge_shield)
 - [![Build Status](https://travis-ci.org/citation-file-format/cff-initializer-javascript.svg?branch=master)](https://travis-ci.org/citation-file-format/cff-initializer-javascript)
+- [![Markdown links](https://github.com/citation-file-format/cff-initializer-javascript/workflows/Check%20Markdown%20links/badge.svg)](https://github.com/citation-file-format/cff-initializer-javascript/actions?query=workflow%3A%22Check+Markdown+links%22)
 
 # Web form to initialize CITATION.cff files.
 
 ![Live version](cffinit-on-ghpages.png)
 
-# For users
+# Documentation for users
 
 - Check out the **live version** [here](https://citation-file-format.github.io/cff-initializer-javascript/).
 - For the rationale behind CITATION.cff files, read [the blog](https://www.software.ac.uk/blog/2017-12-12-standard-format-citation-files).
-- For the Citation File Format specification, go [here](https://citation-file-format.github.io/versions).
+- For the Citation File Format specification, go [here](https://github.com/citation-file-format/citation-file-format) (latest) or [here](https://doi.org/10.5281/zenodo.1003149) (stable).
 - For the Citation File Format home page, go [here](https://citation-file-format.github.io).
 
-# For developers
+# Documentation for developers
 
 ## Build Setup
 
@@ -45,6 +46,13 @@ https://alligator.io/vuejs/vue-eslint-plugin/
 
 Project was bootstrapped with https://github.com/vuejs-templates/webpack-simple
 
+## Markdown link checker
+
+If you want to check if the links in your markdown work, run ``markdown-link-check``
+
+```shell
+find . -name '*.md' -not -path './node_modules/*' -exec markdown-link-check '{}' --config .mlc-config.json ';'
+```
 
 ## License
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcitation-file-format%2Fcff-initializer-javascript.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcitation-file-format%2Fcff-initializer-javascript?ref=badge_large)