diff --git a/.markdown-lint.yml b/.markdown-lint.yml index f173c9fc7..d486f78ec 100644 --- a/.markdown-lint.yml +++ b/.markdown-lint.yml @@ -15,12 +15,14 @@ # # +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 diff --git a/.markdownlintignore b/.markdownlintignore index fddb726cc..09c93cece 100644 --- a/.markdownlintignore +++ b/.markdownlintignore @@ -1,3 +1,4 @@ node_modules CHANGELOG.md build/** +out/** diff --git a/README.md b/README.md index 77b23d87b..6ff976d68 100644 --- a/README.md +++ b/README.md @@ -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. + + ## Third party acknowledgments – many kudos for that !!! + + - [open privacy by opr.vc](https://opr.vc) ## Code of conduct diff --git a/assets/icons/README.md b/assets/icons/README.md index 45d827541..e190af096 100644 --- a/assets/icons/README.md +++ b/assets/icons/README.md @@ -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 diff --git a/package.json b/package.json index d2c8dd9df..b31adf703 100644 --- a/package.json +++ b/package.json @@ -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",