-
Notifications
You must be signed in to change notification settings - Fork 866
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Warnings that occurs when bookmark link contains non-ASCII chars #9660
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9660 +/- ##
=======================================
Coverage 74.31% 74.31%
=======================================
Files 536 536
Lines 23189 23189
Branches 4056 4056
=======================================
Hits 17234 17234
Misses 4853 4853
Partials 1102 1102 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Thank you @filzrev !
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://togithub.com/dotnet/docfx) | `2.75.2` -> `2.75.3` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/docfx/2.75.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/docfx/2.75.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/docfx/2.75.2/2.75.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/docfx/2.75.2/2.75.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>dotnet/docfx (docfx)</summary> ### [`v2.75.3`](https://togithub.com/dotnet/docfx/releases/tag/v2.75.3) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 🐞 Bug Fixes - fix: Toc warnings when toc item with TopicUid but name is not specified by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9665](https://togithub.com/dotnet/docfx/pull/9665) - fix: Warnings that occurs when bookmark link contains non-ASCII chars by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9660](https://togithub.com/dotnet/docfx/pull/9660) - fix: Add StackTrace logs for Javascript error by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9694](https://togithub.com/dotnet/docfx/pull/9694) - fix: InvalidInputFile error occurs if file contains URI escaped charactors by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9700](https://togithub.com/dotnet/docfx/pull/9700) - fix: Add fail-fast logics when `--serve` option enabled & port is already used by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9690](https://togithub.com/dotnet/docfx/pull/9690) - fix: filterconfig exclude rule is not works as documented by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9666](https://togithub.com/dotnet/docfx/pull/9666) ##### 🔧 Engineering - build(deps): bump YamlDotNet from 15.1.0 to 15.1.1 dependencies .NET by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9689](https://togithub.com/dotnet/docfx/pull/9689) - chore: update NuGet package dependencies (Microsoft.NET.Test.Sdk,Microsoft.Build.Locator) by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9693](https://togithub.com/dotnet/docfx/pull/9693) - chore: Update public API snapshot & disable `AutoVerify` on CI build by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9692](https://togithub.com/dotnet/docfx/pull/9692) - chore: Update node.js version by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9701](https://togithub.com/dotnet/docfx/pull/9701) - chore: Update Microsoft.Build package version by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9698](https://togithub.com/dotnet/docfx/pull/9698) **Full Changelog**: dotnet/docfx@v2.75.2...v2.75.3 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9pm,before 6am" in timezone Europe/Zurich, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/buehler/dotnet-operator-sdk). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xOTEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjE5MS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
…dotnet#9660) fix: warnings that occurs when bookmark link contains non-ascii chars
This PR intended to fix issue #5233
By adding
URI normalization
logics when validate bookmark URLs .Examples markdown that contains non-ASCI chars
Generated output HTML
Background
Markdown link
[Québec](#québec)
is converted to url-encoded anchor link (#qu%C3%A9bec
)This behavior is according to the CommonMark spec.
Instead,
## Québec
heading is converted to<h2 id="québec">
Because it's generated by
AutoIdentifier
markdig extension.And docfx explicitly specify
AutoIdentifierOptions.GitHub
options.So bookmark URI validation should be executed by
Normalized URI
comparison.(In this PR. This normalization is executed by
Uri.UnescapeDataString
API).It might be better to use API that comply with the following standard specifications