Added pdfPrintBackground setting by cjlotz · Pull Request #9742 · dotnet/docfx
Navigation Menu
{{ message }}
- Notifications You must be signed in to change notification settings
- Fork 887
Merged
Conversation
Copy link
Contributor
cjlotz
commented
Feb 28, 2024
cjlotz
commented
Added pdfPrintBackground setting to include background graphics as part of pdf printing. Fixes #9740 #9730
Copy link
codecov
bot
commented
Feb 28, 2024
codecov bot commented
Feb 28, 2024Codecov Report
Attention: Patch coverage is 50.00000% with 3 lines in your changes are missing coverage. Please review.
Project coverage is 74.41%. Comparing base (
fe673ec) to head (33de65c).
Report is 44 commits behind head on main.
| Files | Patch % | Lines |
|---|---|---|
| src/Docfx.App/PdfBuilder.cs | 50.00% | 3 Missing ⚠️ |
Additional details and impacted files
@@ Coverage Diff @@ ## main #9742 +/- ## ========================================== + Coverage 74.31% 74.41% +0.09% ========================================== Files 536 536 Lines 23189 23194 +5 Branches 4056 4027 -29 ========================================== + Hits 17234 17260 +26 + Misses 4853 4840 -13 + Partials 1102 1094 -8
☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.
yufeih approved these changes Feb 28, 2024
Copy link
Contributor
yufeih
left a comment
yufeih
left a comment
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Thank you @cjlotz !
yufeih
added
the
new-feature
label
Feb 28, 2024
yufeih
merged commit
bebcd35
into
dotnet:main
BrewTestBot
mentioned this pull request
renovate bot referenced this pull request in dotnet/dotnet-operator-sdk
Apr 7, 2024[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://togithub.com/dotnet/docfx) | `2.75.3` -> `2.76.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>dotnet/docfx (docfx)</summary> ### [`v2.76.0`](https://togithub.com/dotnet/docfx/releases/tag/v2.76.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 🎉 New Features - feat: Add DefineConstants supports for source file based build by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9707](https://togithub.com/dotnet/docfx/pull/9707) - feat: Add additional layout options to modern template by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9737](https://togithub.com/dotnet/docfx/pull/9737) - feat: Add pdfPrintBackground setting by [@​cjlotz](https://togithub.com/cjlotz) in [https://github.com/dotnet/docfx/pull/9742](https://togithub.com/dotnet/docfx/pull/9742) - feat: Update roslyn packages by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9753](https://togithub.com/dotnet/docfx/pull/9753) - feat: Publish nightly pre-release packages by [@​yufeih](https://togithub.com/yufeih) in [https://github.com/dotnet/docfx/pull/9788](https://togithub.com/dotnet/docfx/pull/9788) - feat: Add DLL references support for file-based API metadata generation by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9825](https://togithub.com/dotnet/docfx/pull/9825) - feat: Support DOCFX_SOURCE_REPOSITORY_URL by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9759](https://togithub.com/dotnet/docfx/pull/9759) - feat: Add feature to configure markdig extension by docfx.json configs. by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9820](https://togithub.com/dotnet/docfx/pull/9820) - feat: Support for all emphasis supported by MarkDig by [@​EMaderbacher](https://togithub.com/EMaderbacher) in [https://github.com/dotnet/docfx/pull/9762](https://togithub.com/dotnet/docfx/pull/9762) ##### 🐞 Bug Fixes - fix: `docfx download` command behaviors by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9721](https://togithub.com/dotnet/docfx/pull/9721) - fix: Resolved .NET SDK version problem on source-based API metadata generation by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9713](https://togithub.com/dotnet/docfx/pull/9713) - fix: Don't overwrite `_disabledToc` when metadata is explicitly defined by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9741](https://togithub.com/dotnet/docfx/pull/9741) - fix: Outputted PDF displays garbled characters when name contains non-ASCII chars by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9769](https://togithub.com/dotnet/docfx/pull/9769) - fix: Move script tags into head in modern template by [@​fuzzykiller](https://togithub.com/fuzzykiller) in [https://github.com/dotnet/docfx/pull/9768](https://togithub.com/dotnet/docfx/pull/9768) - fix: Broken examples problems when using inheritdoc tag by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9754](https://togithub.com/dotnet/docfx/pull/9754) - fix: NullReferenceException occurred when both include and exclude are null by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9786](https://togithub.com/dotnet/docfx/pull/9786) - fix: Change JsonSchema EvaluationOptions instance to shared object by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9807](https://togithub.com/dotnet/docfx/pull/9807) - fix: Bug fix Invalid documentation on type parameter [#​9755](https://togithub.com/dotnet/docfx/issues/9755) by [@​soniyaprasad77](https://togithub.com/soniyaprasad77) in [https://github.com/dotnet/docfx/pull/9806](https://togithub.com/dotnet/docfx/pull/9806) ##### 🚀 Performance Improvements - perf: Optimize xrefmap.json file deserialization performance by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9824](https://togithub.com/dotnet/docfx/pull/9824) ##### 🔧 Engineering - chore: percy snapshot by [@​yufeih](https://togithub.com/yufeih) in [https://github.com/dotnet/docfx/pull/9747](https://togithub.com/dotnet/docfx/pull/9747) - chore: Add detailed error message for specific exceptions by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9746](https://togithub.com/dotnet/docfx/pull/9746) - chore: update pdfpig nuget package version by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9803](https://togithub.com/dotnet/docfx/pull/9803) ##### 📄 Documentation - docs: Split docfx CLI reference docs based on commands by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9708](https://togithub.com/dotnet/docfx/pull/9708) - docs: Update markdown documentation regarding MarkDig extension by [@​tbolon](https://togithub.com/tbolon) in [https://github.com/dotnet/docfx/pull/9810](https://togithub.com/dotnet/docfx/pull/9810) - docs: Update `docfx.json` config reference document by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9813](https://togithub.com/dotnet/docfx/pull/9813) - docs: Correct `docfx template` page title by [@​peitschie](https://togithub.com/peitschie) in [https://github.com/dotnet/docfx/pull/9812](https://togithub.com/dotnet/docfx/pull/9812) - docs: Add a warning about relative path resolution. by [@​voroninp](https://togithub.com/voroninp) in [https://github.com/dotnet/docfx/pull/9828](https://togithub.com/dotnet/docfx/pull/9828) #### New Contributors - [@​EMaderbacher](https://togithub.com/EMaderbacher) made their first contribution in [https://github.com/dotnet/docfx/pull/9762](https://togithub.com/dotnet/docfx/pull/9762) - [@​fuzzykiller](https://togithub.com/fuzzykiller) made their first contribution in [https://github.com/dotnet/docfx/pull/9768](https://togithub.com/dotnet/docfx/pull/9768) - [@​soniyaprasad77](https://togithub.com/soniyaprasad77) made their first contribution in [https://github.com/dotnet/docfx/pull/9806](https://togithub.com/dotnet/docfx/pull/9806) - [@​tbolon](https://togithub.com/tbolon) made their first contribution in [https://github.com/dotnet/docfx/pull/9810](https://togithub.com/dotnet/docfx/pull/9810) - [@​peitschie](https://togithub.com/peitschie) made their first contribution in [https://github.com/dotnet/docfx/pull/9812](https://togithub.com/dotnet/docfx/pull/9812) - [@​voroninp](https://togithub.com/voroninp) made their first contribution in [https://github.com/dotnet/docfx/pull/9828](https://togithub.com/dotnet/docfx/pull/9828) **Full Changelog**: dotnet/docfx@v2.75.3...v2.76.0 </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:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
%5D(https%3A%2F%2Frenovatebot.com){kind=link}
ian-buse referenced this pull request in dh2i-devs/dotnet-operator-sdk
May 3, 2024[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docfx](https://togithub.com/dotnet/docfx) | `2.75.3` -> `2.76.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>dotnet/docfx (docfx)</summary> ### [`v2.76.0`](https://togithub.com/dotnet/docfx/releases/tag/v2.76.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### 🎉 New Features - feat: Add DefineConstants supports for source file based build by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9707](https://togithub.com/dotnet/docfx/pull/9707) - feat: Add additional layout options to modern template by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9737](https://togithub.com/dotnet/docfx/pull/9737) - feat: Add pdfPrintBackground setting by [@​cjlotz](https://togithub.com/cjlotz) in [https://github.com/dotnet/docfx/pull/9742](https://togithub.com/dotnet/docfx/pull/9742) - feat: Update roslyn packages by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9753](https://togithub.com/dotnet/docfx/pull/9753) - feat: Publish nightly pre-release packages by [@​yufeih](https://togithub.com/yufeih) in [https://github.com/dotnet/docfx/pull/9788](https://togithub.com/dotnet/docfx/pull/9788) - feat: Add DLL references support for file-based API metadata generation by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9825](https://togithub.com/dotnet/docfx/pull/9825) - feat: Support DOCFX_SOURCE_REPOSITORY_URL by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9759](https://togithub.com/dotnet/docfx/pull/9759) - feat: Add feature to configure markdig extension by docfx.json configs. by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9820](https://togithub.com/dotnet/docfx/pull/9820) - feat: Support for all emphasis supported by MarkDig by [@​EMaderbacher](https://togithub.com/EMaderbacher) in [https://github.com/dotnet/docfx/pull/9762](https://togithub.com/dotnet/docfx/pull/9762) ##### 🐞 Bug Fixes - fix: `docfx download` command behaviors by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9721](https://togithub.com/dotnet/docfx/pull/9721) - fix: Resolved .NET SDK version problem on source-based API metadata generation by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9713](https://togithub.com/dotnet/docfx/pull/9713) - fix: Don't overwrite `_disabledToc` when metadata is explicitly defined by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9741](https://togithub.com/dotnet/docfx/pull/9741) - fix: Outputted PDF displays garbled characters when name contains non-ASCII chars by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9769](https://togithub.com/dotnet/docfx/pull/9769) - fix: Move script tags into head in modern template by [@​fuzzykiller](https://togithub.com/fuzzykiller) in [https://github.com/dotnet/docfx/pull/9768](https://togithub.com/dotnet/docfx/pull/9768) - fix: Broken examples problems when using inheritdoc tag by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9754](https://togithub.com/dotnet/docfx/pull/9754) - fix: NullReferenceException occurred when both include and exclude are null by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9786](https://togithub.com/dotnet/docfx/pull/9786) - fix: Change JsonSchema EvaluationOptions instance to shared object by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9807](https://togithub.com/dotnet/docfx/pull/9807) - fix: Bug fix Invalid documentation on type parameter [#​9755](https://togithub.com/dotnet/docfx/issues/9755) by [@​soniyaprasad77](https://togithub.com/soniyaprasad77) in [https://github.com/dotnet/docfx/pull/9806](https://togithub.com/dotnet/docfx/pull/9806) ##### 🚀 Performance Improvements - perf: Optimize xrefmap.json file deserialization performance by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9824](https://togithub.com/dotnet/docfx/pull/9824) ##### 🔧 Engineering - chore: percy snapshot by [@​yufeih](https://togithub.com/yufeih) in [https://github.com/dotnet/docfx/pull/9747](https://togithub.com/dotnet/docfx/pull/9747) - chore: Add detailed error message for specific exceptions by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9746](https://togithub.com/dotnet/docfx/pull/9746) - chore: update pdfpig nuget package version by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9803](https://togithub.com/dotnet/docfx/pull/9803) ##### 📄 Documentation - docs: Split docfx CLI reference docs based on commands by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9708](https://togithub.com/dotnet/docfx/pull/9708) - docs: Update markdown documentation regarding MarkDig extension by [@​tbolon](https://togithub.com/tbolon) in [https://github.com/dotnet/docfx/pull/9810](https://togithub.com/dotnet/docfx/pull/9810) - docs: Update `docfx.json` config reference document by [@​filzrev](https://togithub.com/filzrev) in [https://github.com/dotnet/docfx/pull/9813](https://togithub.com/dotnet/docfx/pull/9813) - docs: Correct `docfx template` page title by [@​peitschie](https://togithub.com/peitschie) in [https://github.com/dotnet/docfx/pull/9812](https://togithub.com/dotnet/docfx/pull/9812) - docs: Add a warning about relative path resolution. by [@​voroninp](https://togithub.com/voroninp) in [https://github.com/dotnet/docfx/pull/9828](https://togithub.com/dotnet/docfx/pull/9828) #### New Contributors - [@​EMaderbacher](https://togithub.com/EMaderbacher) made their first contribution in [https://github.com/dotnet/docfx/pull/9762](https://togithub.com/dotnet/docfx/pull/9762) - [@​fuzzykiller](https://togithub.com/fuzzykiller) made their first contribution in [https://github.com/dotnet/docfx/pull/9768](https://togithub.com/dotnet/docfx/pull/9768) - [@​soniyaprasad77](https://togithub.com/soniyaprasad77) made their first contribution in [https://github.com/dotnet/docfx/pull/9806](https://togithub.com/dotnet/docfx/pull/9806) - [@​tbolon](https://togithub.com/tbolon) made their first contribution in [https://github.com/dotnet/docfx/pull/9810](https://togithub.com/dotnet/docfx/pull/9810) - [@​peitschie](https://togithub.com/peitschie) made their first contribution in [https://github.com/dotnet/docfx/pull/9812](https://togithub.com/dotnet/docfx/pull/9812) - [@​voroninp](https://togithub.com/voroninp) made their first contribution in [https://github.com/dotnet/docfx/pull/9828](https://togithub.com/dotnet/docfx/pull/9828) **Full Changelog**: dotnet/docfx@v2.75.3...v2.76.0 </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:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request
Jun 28, 2024Added pdfPrintBackground setting to include background graphics as part of pdf printing. Fixes dotnet#9740 dotnet#9730
dependabot
bot
mentioned this pull request
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Makes the pull request to appear in "New Features" section of the next release note
2 participants