Skip to content

Conversation

@yufeih
Copy link
Contributor

@yufeih yufeih commented Sep 21, 2023

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

@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
@yufeih yufeih deleted the md branch September 22, 2023 05:41
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
* 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 <[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

Development

Successfully merging this pull request may close these issues.

2 participants