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

internal/godocfx: better styling of package doc #3804

Closed
3 tasks done
tbpg opened this issue Mar 12, 2021 · 1 comment · Fixed by #3819
Closed
3 tasks done

internal/godocfx: better styling of package doc #3804

tbpg opened this issue Mar 12, 2021 · 1 comment · Fixed by #3819
Assignees
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@tbpg
Copy link
Contributor

tbpg commented Mar 12, 2021

Package docs have a few issues:

  • No syntax highlighting for code blocks. We need class="prettyprint".
  • Markdown style links don't work.
  • Markdown style lists don't work.

These are all issues with the underlying doc.ToHTML that we use. We can't switch to a Markdown parser directly for the package doc because there are the magic GoDoc headers that don't start with #.

func toHTML(s string) string {
buf := &bytes.Buffer{}
doc.ToHTML(buf, s, nil)
return buf.String()
}

@tbpg tbpg added the type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. label Mar 12, 2021
@tbpg tbpg self-assigned this Mar 12, 2021
@tbpg
Copy link
Contributor Author

tbpg commented Mar 15, 2021

Initial Markdown support in #3816.

@tbpg tbpg added the priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. label Mar 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant