From 57b73603518a5264c7664e71b8461ceca437740f Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Fri, 28 Jul 2017 00:13:24 -0400 Subject: [PATCH] Enable MarkDown linting Lint MarkDown files with MarkdownBear and resolve markdown lint issues. Change-Id: I4b18ab8060d8bdc293ef8548ec8e9fd56db3988d Signed-off-by: Thanh Ha --- .coafile | 5 +++++ README.md | 5 +++-- tox.ini | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.coafile b/.coafile index f3678c3a..ba5f8c31 100644 --- 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 76fa0c70..920c98dd 100644 --- 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) + diff --git a/tox.ini b/tox.ini index 52fb4c0b..2483f759 100644 --- 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 -- 2.16.6