From ead5aed85555f84a5f8a279bde74421ab1fdd0dc Mon Sep 17 00:00:00 2001 From: Christopher Krawietz <krawietz@new-communication.de> Date: Mon, 17 May 2021 11:10:13 +0200 Subject: [PATCH] =?UTF-8?q?[TASK]=20=E2=80=94=20added=20markdown=20linting?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .markdownlintrc | 16 ++++++++++++++++ package.json | 3 ++- src/components/README.md | 1 - src/components/accordion.md | 2 +- src/components/buttons.md | 2 -- src/components/progress.md | 2 -- 6 files changed, 19 insertions(+), 7 deletions(-) create mode 100644 .markdownlintrc diff --git a/.markdownlintrc b/.markdownlintrc new file mode 100644 index 0000000..39b68db --- /dev/null +++ b/.markdownlintrc @@ -0,0 +1,16 @@ +{ + "single-h1": { + "level": 3 + }, + "MD007": false, + "MD010": false, + "MD013": false, + "MD022": false, + "MD024": false, + "MD033": false, + "MD026": { + "punctuation": ".,;:!" + }, + "MD028": false, + "MD041": false +} diff --git a/package.json b/package.json index 1bb3cb4..b5dc34f 100755 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "scripts": { "dev": "vuepress dev src", "build": "vuepress build src", - "lint": "eslint --ext .js,.vue" + "lint": "markdownlint src" }, "license": "MIT", "dependencies": { @@ -34,6 +34,7 @@ "eslint-plugin-import": "^2.22.1", "eslint-plugin-prettier": "^3.3.1", "eslint-plugin-vue": "^7.7.0", + "markdownlint-cli": "^0.27.1", "postcss-loader": "^4.2.0", "rfs": "^9.0.3", "sass": "^1.32.8", diff --git a/src/components/README.md b/src/components/README.md index bd98c83..3ad9dc4 100644 --- a/src/components/README.md +++ b/src/components/README.md @@ -59,4 +59,3 @@ generis et misit, sceleratus viribus Clymeneia. Amphitrite alumnus pictae procerum quaterque iurare. Modo alatur, in, sanguis ut flammas Pelasgi et [ferendo](http://quem-est.com/) saepe; resumptis transitus. - diff --git a/src/components/accordion.md b/src/components/accordion.md index ecaa647..5420350 100644 --- a/src/components/accordion.md +++ b/src/components/accordion.md @@ -2,7 +2,7 @@ title: Akkordions tagline: Akkordions --- -# Akkordions +# Akkordions  diff --git a/src/components/buttons.md b/src/components/buttons.md index 24f7d10..ff785ee 100644 --- a/src/components/buttons.md +++ b/src/components/buttons.md @@ -3,7 +3,6 @@ title: Buttons tagline: Buttons --- # Buttons - Mithilfe von Buttons werden verschiedene Handlungsmöglichkeiten des Nutzers dargestellt und klar hierarchisiert. Welche Zielseite durch sie aufgerufen oder welche Aktion ausgelöst wird, kommunizieren Buttons mit einem Label in Audi Type Screen Normal, mit einem Icon oder einer Kombination aus beidem. Buttons geben bei Klick bzw. Tap ein visuelles Feedback in Form eines Response-Effekts sofern die Buttons nicht deaktiviert sind.  @@ -23,4 +22,3 @@ TODO: Button scss einfügen in graustufen ``` </code-block> </code-group> - diff --git a/src/components/progress.md b/src/components/progress.md index 954cf2f..e8cce6b 100644 --- a/src/components/progress.md +++ b/src/components/progress.md @@ -7,5 +7,3 @@ tagline: Progress Elemente Stellen Sie mehrstufige Prozesse oder Formulare stets visuell dar. Ergänzen Sie auf sprachlicher Ebene. Lassen Sie Nutzer:innen von Anfang an wissen, wie viele Schritte insgesamt erforderlich sind und an welchem er/sie sich gerade befinden. Erläutern Sie stets, wofür jeder Einzelschritt dient und was als nächstes kommt. Nach Abschluss geben Sie ein Feedback über den Erfolg sowie darüber, was und wann als nächstes passieren wird.  - - -- GitLab