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
Contributor

@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.

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 March 15, 2021 14:25
@tbpg tbpg requested a review from a team as a code owner March 15, 2021 14:25
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Mar 15, 2021
Copy link
Member

@codyoss codyoss left a comment

Choose a reason for hiding this comment

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

LGTM

@tbpg tbpg added the automerge Merge the pull request once unit tests and other checks pass. label Mar 15, 2021
@gcf-merge-on-green gcf-merge-on-green bot merged commit 56d5d0a into master Mar 15, 2021
@gcf-merge-on-green gcf-merge-on-green bot deleted the markdown branch March 15, 2021 16:24
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Mar 15, 2021
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
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants