diff --git a/.markdown-lint.yml b/.markdown-lint.yml index 42e67919d2e..25c867058e5 100644 --- a/.markdown-lint.yml +++ b/.markdown-lint.yml @@ -29,8 +29,6 @@ MD026: MD028: false MD029: false # Ordered list item prefix MD030: false -MD033: false # Allow inline HTML -MD034: false MD036: false # Emphasis used instead of a heading MD049: false # emphasis-style Emphasis style should be consistent MD053: false diff --git a/.mdlrc b/.mdlrc index fa98c722f8c..f5a0c18b489 100644 --- a/.mdlrc +++ b/.mdlrc @@ -1 +1 @@ -rules "~MD002", "~MD010", "~MD013", "~MD024", "~MD033" +rules "~MD002", "~MD010", "~MD013", "~MD024" diff --git a/README.md b/README.md index 5157ad3218c..5b4045e5d75 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ + + + + # DB UI Core ![Apache 2.0 license badge](https://img.shields.io/badge/License-Apache_2.0-blue.svg) @@ -107,7 +111,7 @@ Please mind the [conventions for git commits](/docs/conventions.adoc#user-conten -This is only the first version of our framework and we really want your feedback - either within the DB UI Channel by Web Dev Community in Microsoft Teams (only available DB internally), or directly at [db-ux-designsystem@deutschebahn.com](mailto:db-ux-designsystem@deutschebahn.com). +This is only the first version of our framework and we really want your feedback - either within the DB UI Channel by Web Dev Community in Microsoft Teams (only available DB internally), or directly at [db-ux-designsystem@deutschebahn.com](mailto:db-ux-designsystem@deutschebahn.com). We're particularly keen to add as many examples to the behaviours as possible, to further clarify them. ## FAQ diff --git a/source/_patterns/.mdlrc b/source/_patterns/.mdlrc index 7f88f202c37..a0e97f121f8 100644 --- a/source/_patterns/.mdlrc +++ b/source/_patterns/.mdlrc @@ -1 +1 @@ -rules "~MD002", "~MD010", "~MD013", "~MD024", "~MD033", "~MD041" +rules "~MD002", "~MD010", "~MD013", "~MD024", "~MD041" diff --git a/source/_patterns/00-global.md b/source/_patterns/00-global.md index 62a8d82b6e0..81218421bdf 100644 --- a/source/_patterns/00-global.md +++ b/source/_patterns/00-global.md @@ -6,6 +6,10 @@ The global category defines visual elements such as color, font families, and mo ## Give us your feedback + + This is only the beta version of our framework and we really want your feedback - either within the DB UI Channel by Web Dev Community in Microsoft Teams (only available DB internally), or directly at [db-ux-designsystem@deutschebahn.com](mailto:db-ux-designsystem@deutschebahn.com). + + We're particularly keen to add as many examples to the behaviours as possible, to further clarify them. diff --git a/source/_patterns/01-elements/image/_image.md b/source/_patterns/01-elements/image/_image.md index b8272e2beae..f1b05b46d2b 100644 --- a/source/_patterns/01-elements/image/_image.md +++ b/source/_patterns/01-elements/image/_image.md @@ -36,7 +36,7 @@ Attention: `PNG` is even also often used for pictures, even though that the spec Regarding images that need to have some kind of full or partial transparency, you could use either `GIF` (full) or `PNG` (most likely `PNG-24` for partial) transparency. -Or use SVG masks, as this beautiful concept shows: https://github.blog/2021-01-29-making-githubs-new-homepage-fast-and-performant/#serving-the-perfect-image +Or use SVG masks, as this beautiful concept shows: ### Diagrams, drawings, and charts @@ -46,7 +46,7 @@ Source: . Nowadays they additionally provide a CLI version of their software and new cool image formats, check out their version 2: https://web.dev/squoosh-v2/ +On top of the possibilities mentioned above regarding image optimizations (Google Guetzli & JPEGMini) you could as well have a look at both [ImageAlpha (for PNG)](https://pngmini.com) and [ImageOptim (for all)](https://imageoptim.com/), both available for Mac and the first [both both other GUI and command-line variants](https://pngquant.org) and the latter as well as a webservice. Another great online tool that works entirely in the browser and doesn't even need to process your data on their servers (due to WebAssembly and some other cool stuff) is . Nowadays they additionally provide a CLI version of their software and new cool image formats, check out their version 2: Some further information on this topic are provided on this page: diff --git a/source/_patterns/01-elements/video/video.md b/source/_patterns/01-elements/video/video.md index 778e4bf8248..5a99ca9a866 100644 --- a/source/_patterns/01-elements/video/video.md +++ b/source/_patterns/01-elements/video/video.md @@ -9,8 +9,8 @@ TODO: Not included within the styleguide at the moment, needs to get investigate Please keep in mind to provide subtitles to your video content via WebVTT files: -- http://html5doctor.com/video-subtitling-and-webvtt/ -- https://www.vtt-creator.com/ +- +- These do not only help people with hearing disabilities, but other users as well that couldn't listen to the sound due to their environment, like e.g. travelling in public transport.