Skip to content

Commit 1f5a540

Browse files
authored
test(markdownlint): doesn't provide correct results (#254)
* fix: markdownlint glob declaration * fix: corrected that URL * refactor: aligned indentation * chore: need to ignore output files * refactor: ignoring this rule at line * test(markdownlint): using the default rules
1 parent 85649d5 commit 1f5a540

File tree

5 files changed

+15
-8
lines changed

5 files changed

+15
-8
lines changed

.markdown-lint.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@
1515
# <!-- markdownlint-restore -->
1616
#
1717

18+
default: true
19+
1820
###############
1921
# Rules by id #
2022
###############
2123
MD004: false # Unordered list style
2224
MD007:
23-
indent: 4 # Unordered list indentation
25+
indent: 2 # Unordered list indentation
2426
MD010: false
2527
MD013:
2628
line_length: 500 # Line length 80 is far to short

.markdownlintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules
22
CHANGELOG.md
33
build/**
4+
out/**

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,12 @@ npm run build
6262

6363
The `npm build` task is what performs the style dictionary build steps to generate the files for each platform. Every time you change something in the style dictionary, like changing colors or adding tokens, you will have to run this command again to generate the files.
6464

65+
<!-- markdownlint-disable MD026 -->
66+
6567
## Third party acknowledgments – many kudos for that !!!
6668

69+
<!-- markdownlint-enable MD026 } -->
70+
6771
- [open privacy by opr.vc](https://opr.vc)
6872

6973
## Code of conduct

assets/icons/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# How to create and provide the technical icon files
22

3-
We're getting these icons by the [DB Design System colleagues](https://dbsw-my.sharepoint.com/personal/maximilian_franzke_deutschebahn_com/_layouts/15/onedrive.aspx?id=%2Fteams%2FCXM%2ETeams%2DDDSTeam%2FShared%20Documents%2FDDS%20Team%2F01%2D%2DDesign%2DSystem%2F04%2D%2DFoundations%2F07%2D%2DIcons%2F04%2D%2DExchange%2DIcons%2F01%2D%2DFunctional&listurl=https%3A%2F%2Fdbsw%2Esharepoint%2Ecom%2Fteams%2FCXM%2ETeams%2DDDSTeam%2FShared%20Documents&viewid=0595d7bc%2Db96a%2D483a%2D8d53%2D87b3356ce9fc) and process the following changes:
3+
We're getting these icons by the [DB Design System colleagues](https://dbsw.sharepoint.com/:f:/r/teams/CXM.Teams-DDSTeam/Shared%20Documents/DDS%20Team/01--Design-System/04--Foundations/07--Icons/04--Exchange-Icons?csf=1&web=1&e=hzdDGu) and process the following changes:
44

5-
- Minifications with [`ImageOptim`](https://imageoptim.com/mac)
6-
- Adding some contents within the SVGs (these assets might get exported correctly in the future)
7-
- CSS variables (replace `fill="#282D37"` by `fill="#282D37" style="fill: currentColor;fill: var(--db-icon-color, currentColor)"`)
8-
- `id`-Attribute (generic `icon` id within all SVG files)
9-
- Afterwards the JSON files within the `source/_patterns/icons` path might need to get updated
5+
- Minifications with [`ImageOptim`](https://imageoptim.com/mac)
6+
- Adding some contents within the SVGs (these assets might get exported correctly in the future)
7+
- CSS variables (replace `fill="#282D37"` by `fill="#282D37" style="fill: currentColor;fill: var(--db-icon-color, currentColor)"`)
8+
- `id`-Attribute (generic `icon` id within all SVG files)
9+
- Afterwards the JSON files within the `source/_patterns/icons` path might need to get updated

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"build": "npm-run-all copy:assets build:* pl:build",
2121
"clean": "git clean -dfx --exclude=.env",
2222
"lint": "npm-run-all -p lint:*",
23-
"lint:markdownlint": "markdownlint -c .markdown-lint.yml **/*.md",
23+
"lint:markdownlint": "markdownlint -c .markdown-lint.yml '**/*.md'",
2424
"lint:stylelint": "stylelint **/*.scss",
2525
"lint:xo": "xo",
2626
"start": "npm-run-all build:style-dictionary --parallel pl:serve watch:tokens watch:scss",

0 commit comments

Comments
 (0)