From 1ff7fe272200c83529ca1b93cae29af444ddbbec Mon Sep 17 00:00:00 2001 From: Alexander Grund <Flamefire@users.noreply.github.com> Date: Thu, 1 Jul 2021 10:40:06 +0200 Subject: [PATCH] Update Doku --- doc.zih.tu-dresden.de/README.md | 7 ++++--- doc.zih.tu-dresden.de/util/README.md | 7 ++++--- howto.md | 2 +- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/doc.zih.tu-dresden.de/README.md b/doc.zih.tu-dresden.de/README.md index 6bb71092e..bf81e7726 100644 --- a/doc.zih.tu-dresden.de/README.md +++ b/doc.zih.tu-dresden.de/README.md @@ -221,13 +221,14 @@ Installation ~ [sudo] npm [-g] install markdownlint-cli ``` -The configuration is stored in `.markdownlint.json`. The tool `markdownlint` can be run in dry or -fix mode. The *dry* mode (default) only outputs findings, whereas in *fix* mode it resolves basic +The configuration is stored in `.markdownlintrc`. +The tool `markdownlint` can be run in dry or fix mode. +The *dry* mode (default) only outputs findings, whereas in *fix* mode it resolves basic errors directly in the markdown files. ```Shell Session ~ cd doc.zih.tu-dresden.de/ -~ markdownlint [--config .markdownlint.json] [--fix] docs/index.md +~ markdownlint [--fix] docs/index.md docs/index.md:8:131 MD013/line-length Line length [Expected: 130; Actual: 138] ``` diff --git a/doc.zih.tu-dresden.de/util/README.md b/doc.zih.tu-dresden.de/util/README.md index 2660eeb55..63c9125cf 100644 --- a/doc.zih.tu-dresden.de/util/README.md +++ b/doc.zih.tu-dresden.de/util/README.md @@ -21,13 +21,14 @@ Installation ~ npm install markdownlint-cli ``` -The configuration is stored in `.markdownlint.json`. The tool `markdownlint` can be run in dry or -fix mode. The *dry* mode (default) only outputs findings, whereas in *fix* mode it resolves basic +The configuration is stored in `.markdownlintrc`. +The tool `markdownlint` can be run in dry or fix mode. +The *dry* mode (default) only outputs findings, whereas in *fix* mode it resolves basic errors directly in the markdown files. ```Shell Session ~ cd doc.zih.tu-dresden.de/ -~ markdownlint [--config .markdownlint.json] [--fix] docs/index.md +~ markdownlint [--fix] docs/index.md docs/index.md:8:131 MD013/line-length Line length [Expected: 130; Actual: 138] ``` diff --git a/howto.md b/howto.md index 1d3cbd46a..7627889f6 100644 --- a/howto.md +++ b/howto.md @@ -20,7 +20,7 @@ git checkout -b RomeNodes ## 3. Run the linter: ```Bash -markdownlint --config .markdownlint.json ./docs/use_of_hardware/RomeNodes.md +markdownlint ./docs/use_of_hardware/RomeNodes.md ``` If there are still errors: go to step 2 -- GitLab