From 680f7067b8095f73aead3eddf2557d87770d5f6f Mon Sep 17 00:00:00 2001 From: richelbilderbeek Date: Tue, 14 May 2024 12:55:23 +0200 Subject: [PATCH] Use markdownlint config file in root --- README.md | 11 ++++++----- .../markdownlint-config.json => markdownlint.json | 0 2 files changed, 6 insertions(+), 5 deletions(-) rename .github/workflows/markdownlint-config.json => markdownlint.json (100%) diff --git a/README.md b/README.md index 2684dd893..9e47a310a 100644 --- a/README.md +++ b/README.md @@ -70,11 +70,12 @@ python3 scripts/md_to_speech.py --input txt.md --lang en ## Files used by continuous integration scripts -Filename |Descriptions ------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------- -[mlc_config.json](mlc_config.json) |Configuration of the link checker, use `markdown-link-check --config mlc_config.json --quiet docs/**/*.md` to do link checking locally -[.spellcheck.yml](.spellcheck.yml) |Configuration of the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally -[.wordlist.txt](.wordlist.txt) |Whitelisted words for the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally +Filename |Descriptions +--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------- +[mlc_config.json](mlc_config.json) |Configuration of the link checker, use `markdown-link-check --config mlc_config.json --quiet docs/**/*.md` to do link checking locally +[.spellcheck.yml](.spellcheck.yml) |Configuration of the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally +[.wordlist.txt](.wordlist.txt) |Whitelisted words for the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally +[markdownlint.json](markdownlint.json)|Configuration of the markdown linter, use `markdownlint --config markdownlint.json **/*.md` to do markdown linting locally ## Credits diff --git a/.github/workflows/markdownlint-config.json b/markdownlint.json similarity index 100% rename from .github/workflows/markdownlint-config.json rename to markdownlint.json