Skip to content
Snippets Groups Projects
Unverified Commit 1ff7fe27 authored by Alexander Grund's avatar Alexander Grund
Browse files

Update Doku

parent 1cb6dcb4
No related branches found
No related tags found
3 merge requests!322Merge preview into main,!319Merge preview into main,!137Fix linter
......@@ -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]
```
......
......@@ -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]
```
......
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment