Enable MarkDown linting

Lint MarkDown files with MarkdownBear and resolve markdown lint issues.

Change-Id: I4b18ab8060d8bdc293ef8548ec8e9fd56db3988d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/.coafile b/.coafile
index f3678c3..ba5f8c3 100644 (file)
--- a/.coafile
+++ b/.coafile
@@ -18,6 +18,11 @@ ignore_length_regex = Signed-off-by,
 bears = WriteGoodLintBear
 files = docs/**/*.rst
 
+[all.MarkDown]
+bears = MarkdownBear,SpaceConsistencyBear,WriteGoodLintBear
+files = **.md, **.markdown
+use_spaces = true
+
 [all.Python]
 bears = BanditBear,
     PEP8Bear,

diff --git a/README.md b/README.md
index 76fa0c7..920c98d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-This project's documentation can be found on ReadTheDocs (RTD)
+# LF Tools
 
-https://lf-releng-tools.readthedocs.io
+This project's documentation is available on ReadTheDocs (RTD)
 
+<https://lf-releng-tools.readthedocs.io>

diff --git a/tox.ini b/tox.ini
index 52fb4c0..2483f75 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -23,7 +23,7 @@ deps =
     nodeenv==1.1.2
 commands =
     nodeenv -p
-    npm install --global write-good
+    npm install --global remark-cli remark-lint write-good
     python3 -m nltk.downloader punkt maxent_treebank_pos_tagger averaged_perceptron_tagger
     coala --non-interactive