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

feat(internal/godocfx): handle Markdown content #3816

Merged
merged 9 commits into from Mar 15, 2021
Merged

Conversation

@tbpg
Copy link
Collaborator

@tbpg tbpg commented Mar 15, 2021

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:

  • Add syntax highlighting for code blocks.
  • Maybe add ` tags around code elements in the comment.
  • Maybe support Markdown in other doc comments.
tbpg added 2 commits Mar 12, 2021
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.
@tbpg tbpg requested a review from codyoss Mar 15, 2021
@tbpg tbpg requested a review from googleapis/yoshi-go-admins as a code owner Mar 15, 2021
@google-cla google-cla bot added the cla: yes label Mar 15, 2021
Copy link
Member

@codyoss codyoss left a comment

LGTM

@tbpg tbpg added the automerge label Mar 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants