diff --git a/doc.zih.tu-dresden.de/.markdownlint.json b/.markdownlintrc similarity index 100% rename from doc.zih.tu-dresden.de/.markdownlint.json rename to .markdownlintrc diff --git a/doc.zih.tu-dresden.de/README.md b/doc.zih.tu-dresden.de/README.md index 6bb71092e91273c6bf57d9145a9a3308b50e1095..bf81e772683de7ce9348756551142f54f3d2819b 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 2660eeb555cb1c400e8beac4715a3d5691c03e04..63c9125cf19e711b12dd480741ad38050143393f 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 1d3cbd46a60abbdbfa6dcad8802892b0d522d0ec..7627889f6ab3686c9322ea88f51e555dc1c365f1 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 diff --git a/linkchecker/Dockerfile b/linkchecker/Dockerfile deleted file mode 100644 index 5fa5ae88233b5447414c1bc624c24ae95b8c2d2c..0000000000000000000000000000000000000000 --- a/linkchecker/Dockerfile +++ /dev/null @@ -1,14 +0,0 @@ -FROM debian:buster - -############### -# Linkchecker # -############### - -RUN apt update && apt install -y linkchecker - -WORKDIR /src/linkchecker - -ENTRYPOINT ["/usr/bin/linkchecker"] - -CMD ["--help"] - diff --git a/linter/Dockerfile b/linter/Dockerfile deleted file mode 100644 index 5ca65137d98cba7eb455d015a6af3b2472d6c0c0..0000000000000000000000000000000000000000 --- a/linter/Dockerfile +++ /dev/null @@ -1,16 +0,0 @@ -FROM webpage:base - -########## -# Linter # -########## - -RUN apt update && apt install -y nodejs npm - -RUN npm install -g markdownlint-cli - -WORKDIR /src/linter - -ENTRYPOINT ["/usr/local/bin/markdownlint"] - -CMD ["--help"] - diff --git a/linter/config.json b/linter/config.json deleted file mode 100644 index 6da021f5d99b8fe4191d6db6c010cc7ee1aac57b..0000000000000000000000000000000000000000 --- a/linter/config.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "default": false, - "first-heading-h1": true, - "header-increment": true, - "heading-style": { "style": "atx" }, - "no-missing-space-atx": true, - "no-multiple-space-atx": true, - "blanks-around-headings": true, - "no-emphasis-as-heading": true, - "first-line-heading": true, - "single-title": true, - "no-empty-links": true, - "no-alt-text": true, - "no-multiple-blanks": true, - "single-trailing-newline": true, - "blanks-around-fences": true, - "blanks-around-lists": true, - "commands-show-output": true, - "line-length": { "line_length": 100, "code_blocks": false, "tables": false} -}