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.

Sign up for GitHub

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

Jump to bottom

feat: experimental support for markdown output #9232

Merged
merged 14 commits into from
Sep 22, 2023
Merged

feat: experimental support for markdown output #9232

merged 14 commits into from
Sep 22, 2023

Conversation

yufeih
Copy link
Contributor

@yufeih yufeih commented Sep 21, 2023 •
edited
Loading

Allow generating markdown output with docfx metadata --outputFormat markdown or { "outputFormat": "markdown" } JSON config.

  • Supports basic markdown output for class, struct, interface, delegate and enums, TOC.
  • Does not support namespace pages.
  • Does not support proper markdown escaping.
  • Does not support in-page anchors.
  • Does not support separated member pages and nested namespace.
  • Does not support merging extension methods
  • Does not support localized markdown pages.

Design Note:

  • Markdown support is added to metadata command so it will not work with build command features such as overwrite files and custom template.
  • Markdown support is built directly on Roslyn, as opposed to the ManagedReference YAML model. This may introduce subtle behavior differences with the HTML output. Overtime, we expect to converge both formats to sit directly on Roslyn and address behavior gaps.

#684

@yufeih yufeih added the new-feature Makes the pull request to appear in "New Features" section of the next release note label Sep 21, 2023
@codecov
Copy link

codecov bot commented Sep 21, 2023 •
edited
Loading

Codecov Report

Patch coverage is 4.24% of modified lines.

Files Changed Coverage
src/Docfx.Dotnet/MarkdownFormatter.cs 0.00%
src/Docfx.Dotnet/SymbolHelper.cs 0.00%
...fx.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs 33.33%
src/Docfx.Dotnet/SymbolUrlResolver.cs 88.88%
src/Docfx.Dotnet/DotnetApiCatalog.cs 100.00%
...fx.Dotnet/ExtractMetadata/ExtractMetadataConfig.cs 100.00%
src/Docfx.Dotnet/MetadataJsonConfig.cs 100.00%
src/Docfx.Dotnet/SymbolFormatter.cs 100.00%
src/docfx/Models/MetadataCommand.cs 100.00%
src/docfx/Models/MetadataCommandOptions.cs 100.00%

📢 Thoughts on this report? Let us know!.

@yufeih yufeih marked this pull request as ready for review September 21, 2023 09:54
@yufeih yufeih closed this Sep 21, 2023
@yufeih yufeih reopened this Sep 21, 2023
@yufeih yufeih closed this Sep 21, 2023
@yufeih yufeih reopened this Sep 21, 2023
@yufeih yufeih closed this Sep 22, 2023
@yufeih yufeih reopened this Sep 22, 2023
@yufeih yufeih merged commit f990af1 into main Sep 22, 2023
7 checks passed
@yufeih yufeih deleted the md branch September 22, 2023 05:41
@p-linnane p-linnane mentioned this pull request Sep 30, 2023
Merged
@soroshsabz soroshsabz mentioned this pull request Nov 1, 2023
Open
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
@yufeih @p-kostov
feat: experimental support for markdown output (dotnet#9232)
6e215e1 
* feat: initial support of markdown output

* Fix tests

* publish seed markdown to gh pages for preview

* test(snapshot): update snapshots for 3b46445

* separate ns and assembly as two lines

* test(snapshot): update snapshots for 2f52e6b

* use soft break for info

* test(snapshot): update snapshots for 7ebfed1

* basic TOC generation

* test(snapshot): update snapshots for 5a64955

---------

Co-authored-by: Yufei Huang <yufeih@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
new-feature Makes the pull request to appear in "New Features" section of the next release note
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@yufeih