Skip to content

Commit

Permalink
test(markdownlint): doesn't provide correct results (#254)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
mfranzke authored Feb 15, 2023
1 parent 85649d5 commit 1f5a540
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 8 deletions.
4 changes: 3 additions & 1 deletion .markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@
# <!-- markdownlint-restore -->
#

default: true

###############
# Rules by id #
###############
MD004: false # Unordered list style
MD007:
indent: 4 # Unordered list indentation
indent: 2 # Unordered list indentation
MD010: false
MD013:
line_length: 500 # Line length 80 is far to short
Expand Down
1 change: 1 addition & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
CHANGELOG.md
build/**
out/**
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,12 @@ npm run build

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.

<!-- markdownlint-disable MD026 -->

## Third party acknowledgments – many kudos for that !!!

<!-- markdownlint-enable MD026 } -->

- [open privacy by opr.vc](https://opr.vc)

## Code of conduct
Expand Down
12 changes: 6 additions & 6 deletions assets/icons/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# How to create and provide the technical icon files

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:
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:

- Minifications with [`ImageOptim`](https://imageoptim.com/mac)
- Adding some contents within the SVGs (these assets might get exported correctly in the future)
- CSS variables (replace `fill="#282D37"` by `fill="#282D37" style="fill: currentColor;fill: var(--db-icon-color, currentColor)"`)
- `id`-Attribute (generic `icon` id within all SVG files)
- Afterwards the JSON files within the `source/_patterns/icons` path might need to get updated
- Minifications with [`ImageOptim`](https://imageoptim.com/mac)
- Adding some contents within the SVGs (these assets might get exported correctly in the future)
- CSS variables (replace `fill="#282D37"` by `fill="#282D37" style="fill: currentColor;fill: var(--db-icon-color, currentColor)"`)
- `id`-Attribute (generic `icon` id within all SVG files)
- Afterwards the JSON files within the `source/_patterns/icons` path might need to get updated
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"build": "npm-run-all copy:assets build:* pl:build",
"clean": "git clean -dfx --exclude=.env",
"lint": "npm-run-all -p lint:*",
"lint:markdownlint": "markdownlint -c .markdown-lint.yml **/*.md",
"lint:markdownlint": "markdownlint -c .markdown-lint.yml '**/*.md'",
"lint:stylelint": "stylelint **/*.scss",
"lint:xo": "xo",
"start": "npm-run-all build:style-dictionary --parallel pl:serve watch:tokens watch:scss",
Expand Down

0 comments on commit 1f5a540

Please sign in to comment.