From 0897a25174c0df8efece8da50f92902bb1b2fe07 Mon Sep 17 00:00:00 2001 From: icex2 Date: Mon, 29 Jan 2024 23:17:04 +0100 Subject: [PATCH] feat(dev): Add markdown document formatting Apply a consistent style across all markdown documents. Use mdformat (https://github.com/executablebooks/mdformat) to achieve that. Improves maintainability and readability. --- GNUmakefile | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/GNUmakefile b/GNUmakefile index be0bd9b..8328962 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -43,6 +43,7 @@ FORCE: build-docker \ clean \ code-format \ +doc-format \ print-building \ print-release \ run-tests \ @@ -53,6 +54,7 @@ release: \ print-release \ clean \ code-format \ +doc-format \ all \ run-tests @@ -74,6 +76,10 @@ code-format: $(V)echo "Applying clang-format..." $(V)find src/main src/test -name '*.c' -o -name '*.h' | xargs clang-format -i -style=file +doc-format: + $(V)echo "Applying mdformat on all docs..." + $(V)find . -name '*.md' | xargs mdformat --wrap 100 + run-tests: $(V)echo "Running tests..." $(V)./run-tests-wine.sh