From bbf197eaf3c96b9a6ada6532ec970b59751ca9c6 Mon Sep 17 00:00:00 2001 From: Stefan Greve Date: Wed, 28 Oct 2026 21:02:12 +0100 Subject: [PATCH] Fix doc and rename ParseSetexHeadings to ParseSetextHeadings (#973) Adds ParagraphBlockParser.ParseSetextHeadings and keeps ParseSetexHeadings as an [Obsolete] alias, fixes typos in exception messages and XML docs, corrects the footnotes, media links and DisableHtml docs that contradicted the code, and removes the stale PackageReleaseNotes link to changelog.md. --- contributing.md | 3 +-- site/docs/extensions/footnotes.md | 20 ++++++------------- site/docs/extensions/media-links.md | 11 +++++----- site/docs/usage.md | 2 +- src/Markdig.Tests/MiscTests.cs | 13 ++++++++++++ .../Extensions/Alerts/AlertBlockRenderer.cs | 2 +- .../AutoIdentifierExtension.cs | 6 +++--- src/Markdig/Markdig.targets | 1 - src/Markdig/MarkdownExtensions.cs | 17 +++++++++------- src/Markdig/Parsers/ParagraphBlockParser.cs | 20 ++++++++++++++----- src/Markdig/Parsers/ThematicBreakParser.cs | 10 +++++----- src/Markdig/Syntax/ContainerBlock.cs | 6 +++--- src/Markdig/Syntax/LeafBlock.cs | 4 ++-- 13 files changed, 65 insertions(+), 50 deletions(-) diff --git a/contributing.md b/contributing.md index d81796bf..dcf15b92 100644 --- a/contributing.md +++ b/contributing.md @@ -25,9 +25,8 @@ reserve breaking changes until the next major version release. We welcome anyone that wants to contribute to `Markdig` to triage and reply to open issues to help troubleshoot and fix existing bugs. Here is what you can do: -- Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section, +- Help ensure that existing issues follow the recommendations from the _[Reporting Issues](#reporting-issues)_ section, providing feedback to the issue's author on what might be missing. - instructions and code samples. - Review existing pull requests, and testing patches against real existing applications that use `Markdig`. - Write a test, or add a missing test case to an existing test. diff --git a/site/docs/extensions/footnotes.md b/site/docs/extensions/footnotes.md index 1054d49a..bc1f6787 100644 --- a/site/docs/extensions/footnotes.md +++ b/site/docs/extensions/footnotes.md @@ -54,29 +54,21 @@ This has a long footnote[^long]. - Even lists work in footnotes - Like this one -## Inline footnotes - -You can also define footnotes inline (though this is less common): - -```markdown -This has an inline footnote^[This is the inline footnote content]. -``` - ## HTML output -Footnote references become superscript links, and footnote definitions are collected into a `
` at the end of the page: +Footnote references become superscript links, and footnote definitions are collected into a `
` at the end of the page: ```html -

Text with a footnote1.

+

Text with a footnote1.

-
+
+
  1. -

    This is the footnote content. - ↩

    +

    This is the footnote content.↩

-
+
``` ## Rules diff --git a/site/docs/extensions/media-links.md b/site/docs/extensions/media-links.md index 75df17de..62782ba3 100644 --- a/site/docs/extensions/media-links.md +++ b/site/docs/extensions/media-links.md @@ -13,10 +13,9 @@ This extension converts image links (`![...](url)`) pointing to known media serv {.table} | Service | URL pattern | |---|---| -| YouTube | `youtube.com/watch?v=...`, `youtu.be/...` | +| YouTube | `www.youtube.com/watch?v=...`, `youtu.be/...` | | Vimeo | `vimeo.com/...` | -| Dailymotion | `dailymotion.com/video/...` | -| Yandex | `video.yandex.ru/...` | +| Yandex | `music.yandex.ru/album/.../track/...` | | Odnoklassniki | `ok.ru/video/...` | ## Syntax @@ -30,7 +29,7 @@ Use standard Markdown image syntax with a media URL: ## HTML output ```html - @@ -38,12 +37,12 @@ Use standard Markdown image syntax with a media URL: ## Direct media files -For direct links to media files the extension supports: +For direct links to media files the extension supports, among others (see `MediaOptions.ExtensionToMimeType`): {.table} | Format | Type | |---|---| -| `.mp4`, `.webm`, `.ogg` | `