Skip to content

Commit e3cb2fc

Browse files
authored
refactor: markdownlint rules (#259)
* refactor(markdownlint): remove inline HTML allowance if we would like to add specific tags in the future, we could so via a whitelist from now on * refactor: it doesn't make any sense to deactivate this rule
1 parent da343e6 commit e3cb2fc

File tree

7 files changed

+15
-9
lines changed

7 files changed

+15
-9
lines changed

.markdown-lint.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ MD026:
2929
MD028: false
3030
MD029: false # Ordered list item prefix
3131
MD030: false
32-
MD033: false # Allow inline HTML
33-
MD034: false
3432
MD036: false # Emphasis used instead of a heading
3533
MD049: false # emphasis-style Emphasis style should be consistent
3634
MD053: false

.mdlrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
rules "~MD002", "~MD010", "~MD013", "~MD024", "~MD033"
1+
rules "~MD002", "~MD010", "~MD013", "~MD024"

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
<!-- markdownlint-configure-file { "MD013": false, "MD041":false } -->
22

3+
<!-- markdownlint-disable MD033 -->
4+
35
<img src="source/samples/images/header_image_0.guetzli.jpg" alt="" srcset="source/samples/images/header_image_0.guetzli.2x.jpg 2x, source/samples/images/header_image_0.guetzli.3x.jpg 3x"> <!-- width="830" height="276" //-->
46

7+
<!-- markdownlint-enable MD033 -->
8+
59
# DB UI Core
610

711
![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
107111

108112
<!-- markdownlint-disable MD033 -->
109113

110-
This is only the first version of our framework and we really want your feedback - either within the <a href="https://db.de/krnm74" target="_blank" rel="noopener noreferrer">DB UI Channel by Web Dev Community in Microsoft Teams (only available DB internally)</a>, or directly at [[email protected]](mailto:[email protected]). <!-- markdownlint-disable MD033 -->
114+
This is only the first version of our framework and we really want your feedback - either within the <a href="https://db.de/krnm74" target="_blank" rel="noopener noreferrer">DB UI Channel by Web Dev Community in Microsoft Teams (only available DB internally)</a>, or directly at [[email protected]](mailto:[email protected]).
111115
We're particularly keen to add as many examples to the behaviours as possible, to further clarify them.
112116

113117
## FAQ

source/_patterns/.mdlrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
rules "~MD002", "~MD010", "~MD013", "~MD024", "~MD033", "~MD041"
1+
rules "~MD002", "~MD010", "~MD013", "~MD024", "~MD041"

source/_patterns/00-global.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ The global category defines visual elements such as color, font families, and mo
66

77
## Give us your feedback
88

9+
<!-- markdownlint-disable MD033 -->
10+
911
This is only the beta version of our framework and we really want your feedback - either within the <a href="https://db.de/krnm74" target="_blank" rel="noopener noreferrer">DB UI Channel by Web Dev Community in Microsoft Teams (only available DB internally)</a>, or directly at [[email protected]](mailto:[email protected]).
1012

13+
<!-- markdownlint-enable MD033 -->
14+
1115
We're particularly keen to add as many examples to the behaviours as possible, to further clarify them.

source/_patterns/01-elements/image/_image.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Attention: `PNG` is even also often used for pictures, even though that the spec
3636

3737
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.
3838

39-
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
39+
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>
4040

4141
### Diagrams, drawings, and charts
4242

@@ -46,7 +46,7 @@ Source: <https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types#
4646

4747
## Further image compressions
4848

49-
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 <https://squoosh.app>. 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/
49+
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 <https://squoosh.app>. 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/>
5050

5151
Some further information on this topic are provided on this page: <https://dev.to/prototyp/optimizing-images-for-the-web-an-in-depth-guide-4j7d>
5252

source/_patterns/01-elements/video/video.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ TODO: Not included within the styleguide at the moment, needs to get investigate
99

1010
Please keep in mind to provide subtitles to your video content via WebVTT files:
1111

12-
- http://html5doctor.com/video-subtitling-and-webvtt/
13-
- https://www.vtt-creator.com/
12+
- <http://html5doctor.com/video-subtitling-and-webvtt/>
13+
- <https://www.vtt-creator.com/>
1414

1515
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.
1616

0 commit comments

Comments
 (0)