feat(internal/godocfx): handle Markdown content #3816
Merged
Conversation
This file contains 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
Copied from Go 1.16. I left out the testdata.
I added ToMarkdown to the doc package. I got the idea from @dmitshur, who pointed me to http://golang.org/issues/34875. Once the comment is converted to Markdown, it gets converted to HTML by goldmark. Future changes will: * Add syntax highlighting for code blocks. * Maybe add \` tags around code elements in the comment. * Maybe support Markdown in other doc comments.
google-cla
bot
added
the
cla: yes
tbpg
added
the
automerge
codyoss
reviewed
Mar 15, 2021
codyoss
approved these changes
Mar 15, 2021
gcf-merge-on-green
bot
removed
the
automerge
3 tasks
This was referenced Mar 18, 2021
Merged
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Oct 3, 2022
The previous setup was rendering doc headings as H1s. Now that the default GoDoc supports links and lists, we can use it directly. As a result, we can delete the third_party copy of the go/doc package and the custom goldmark plugin. `ToMarkdown` was added in #3816.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The first commit copied the go/doc package into
third_party.Then, I added ToMarkdown to the doc package. I got the idea from @dmitshur,
who pointed me to http://golang.org/issues/34875.
Once the comment is converted to Markdown, it gets converted to HTML by
goldmark.Future changes will: