Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-01-03 06:28:49 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

wip

Browse source
This commit is contained in:
David Anson 2025-11-27 19:45:22 -08:00
parent d8bf33dde6
commit 4541ee3dd2
17 changed files with 395 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

29
doc-build/md013.md
View file

@ -7,11 +7,11 @@ up into multiple lines. To set a different maximum length for headings, use
This rule has an exception when there is no whitespace beyond the configured
line length. This allows you to include items such as long URLs without being
forced to break them in the middle. To disable this exception, set the `strict`
parameter to `true` and an issue will be reported when any line is too long. To
warn for lines that are too long and could be fixed but allow long lines
parameter to `true` and a violation will be reported when any line is too long.
To warn for lines that are too long and could be fixed while allowing long lines
without spaces, set the `stern` parameter to `true`.
For example (assuming normal behavior):
For example (assuming default behavior):
```markdown
IF THIS LINE IS THE MAXIMUM LENGTH
@ -26,14 +26,25 @@ mode, the middle two lines above are both violations, but the last is okay.
You have the option to exclude this rule for code blocks, tables, or headings.
To do so, set the `code_blocks`, `tables`, or `headings` parameter(s) to false.
Code blocks are included in this rule by default since it is often a
requirement for document readability, and tentatively compatible with code
rules. Still, some languages do not lend themselves to short lines.
Code blocks are included in this rule by default since it is often a requirement
for document readability, and tentatively compatible with code rules. However,
some languages do not lend themselves to short lines.
By default, this rule treats the number of characters in the line as its length.
Many editors render [emoji][emoji-013] and [CJK characters][cjk-characters-013]
at *twice* the width of [Latin characters][latin-script-013], so the
`wide_characters` parameter can be set to `true` to treat the "visual" width of
the line as its length instead.
Lines with link/image reference definitions and standalone lines (i.e., not part
of a paragraph) with only a link/image (possibly using (strong) emphasis) are
always exempted from this rule (even in `strict` mode) because there is often no
way to split such lines without breaking the URL.
of a paragraph) with only a link/image (possibly using emphasis) are always
exempted from this rule (even in `strict` mode) because there is often no way to
split such lines without breaking the URL.
Rationale: Extremely long lines can be difficult to work with in some editors.
More information: <https://cirosantilli.com/markdown-style-guide#line-wrapping>.
[cjk-characters-013]: https://en.wikipedia.org/wiki/CJK_characters
[emoji-013]: https://en.wikipedia.org/wiki/Emoji
[latin-script-013]: https://en.wikipedia.org/wiki/Latin_script

16
doc-build/md060.md
View file

@ -47,11 +47,11 @@ not, violations are be reported for whichever style would produce the *fewest*
issues (i.e., whichever style is the closest match).
Note: Delimiter placement for the `aligned` style is based on visual appearance
and not character count. Because editors typically render [emoji][emoji] and
[CJK characters][cjk-characters] at *twice* the width of
[Latin characters][latin-script], this rule takes that into account for tables
using the `aligned` style. The following table is correctly formatted and will
appear aligned in most editors and monospaced fonts:
and not character count. Because editors typically render [emoji][emoji-060] and
[CJK characters][cjk-characters-060] at *twice* the width of
[Latin characters][latin-script-060], this rule takes that into account for
tables using the `aligned` style. The following table is correctly formatted and
will appear aligned in most editors and monospaced fonts:
<!-- markdownlint-capture -->
<!-- markdownlint-disable extended-ascii -->
@ -67,7 +67,7 @@ appear aligned in most editors and monospaced fonts:
Rationale: Consistent formatting makes it easier to understand a document.
[cjk-characters]: https://en.wikipedia.org/wiki/CJK_characters
[emoji]: https://en.wikipedia.org/wiki/Emoji
[cjk-characters-060]: https://en.wikipedia.org/wiki/CJK_characters
[emoji-060]: https://en.wikipedia.org/wiki/Emoji
[gfm-table-060]: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables
[latin-script]: https://en.wikipedia.org/wiki/Latin_script
[latin-script-060]: https://en.wikipedia.org/wiki/Latin_script