Skip to content
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

Added extensions configuration point and PlantUml support #9574

Merged
merged 5 commits into from
Jan 3, 2024
Merged

Added extensions configuration point and PlantUml support #9574

merged 5 commits into from
Jan 3, 2024

Conversation

cjlotz
Copy link
Contributor

@cjlotz cjlotz commented Jan 2, 2024

As discussed in #9566 , this pull request aims to add support for rendering PlantUml diagrams using the latest docfx toolchain. This will unblock all existing users who want to continue using docfx and PlantUml.

This comment covers the approach taken to implement the PlantUmlExtension. Some basic tests were added for the extension points touched. As mentioned some tests in the QuoteSectionNoteTest are failing which seems to be related to CR-LF return issues which I am unable to resolve. Help for getting this resolved will be much appreciated.

fixes #2347 fixes #8763 fixes #9566

@cjlotz cjlotz changed the title Added extensions configuration point and PlantUmlExtension Added extensions configuration point and PlantUml support Jan 2, 2024
@cjlotz
Copy link
Contributor Author

cjlotz commented Jan 2, 2024

@dotnet-policy-service agree

@yufeih yufeih added the new-feature Makes the pull request to appear in "New Features" section of the next release note label Jan 2, 2024
@cjlotz
Copy link
Contributor Author

cjlotz commented Jan 2, 2024

@dotnet-policy-service agree

Copy link
Contributor

@yufeih yufeih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @cjlotz . This is a great addition and addresses one of the most asked features #2347

@cjlotz
Copy link
Contributor Author

cjlotz commented Jan 2, 2024

Thank you @cjlotz . This is a great addition and addresses one of the most asked features #2347

@yufeih Glad to assist. I will be away on some leave soon, so let me know if there is anything left to do to enable you to merge the pull request. Looking forward to using the latest version of docfx with this included.

Copy link

codecov bot commented Jan 3, 2024

Codecov Report

Attention: 28 lines in your changes are missing coverage. Please review.

Comparison is base (b44364d) 74.35% compared to head (5e9302a) 74.33%.
Report is 8 commits behind head on main.

Files Patch % Lines
...e.Extensions/PlantUml/PlantUmlCodeBlockRenderer.cs 61.29% 11 Missing and 1 partial ⚠️
...digEngine.Extensions/PlantUml/PlantUmlExtension.cs 61.29% 6 Missing and 6 partials ⚠️
src/Docfx.Plugins/MarkdownServiceParameters.cs 50.00% 1 Missing and 2 partials ⚠️
.../Docfx.MarkdigEngine.Extensions/MarkdownContext.cs 75.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9574      +/-   ##
==========================================
- Coverage   74.35%   74.33%   -0.02%     
==========================================
  Files         534      536       +2     
  Lines       23099    23175      +76     
  Branches     4044     4057      +13     
==========================================
+ Hits        17175    17227      +52     
- Misses       4825     4841      +16     
- Partials     1099     1107       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yufeih yufeih merged commit 0cfc17f into dotnet:main Jan 3, 2024
8 checks passed
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
…et#9574)

* Added extensions configuration point and PlantUmlExtension

* Address review comments and improve error handling of PlantUmlExtension

* Remove output formatters

* Update JsonConverterTest.cs to ignoreLineEndingDifferences

* Update JsonConverterTest.cs

---------

Co-authored-by: Yufei Huang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature Makes the pull request to appear in "New Features" section of the next release note
Projects
None yet
3 participants