diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index f4a77e1..4644b97 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,6 +13,11 @@ jobs: steps: - uses: actions/checkout@v7 + - name: Lint Markdown + uses: DavidAnson/markdownlint-cli2-action@v23 + with: + globs: "**/*.md" + - name: Check formatting run: make format-check diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..2bf8ad4 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,8 @@ +{ + "MD013": { + "line_length": 100 + }, + "MD024": { + "siblings_only": true + } +} diff --git a/README.md b/README.md index ce47a6b..bfd351b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Smart Home Refactoring C++ Kata +# Smart home refactoring kata in C++ [![CI](https://github.com/Coding-Cuddles/smart-home-refactoring-cpp-kata/actions/workflows/main.yml/badge.svg)](https://github.com/Coding-Cuddles/smart-home-refactoring-cpp-kata/actions/workflows/main.yml) [![C++17](https://img.shields.io/badge/C%2B%2B-17-blue.svg)](https://en.cppreference.com/w/cpp/17)