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

Add index section #4

Open
infogulch opened this issue Jan 2, 2014 · 1 comment
Open

Add index section #4

infogulch opened this issue Jan 2, 2014 · 1 comment

Comments

@infogulch
Copy link

Is there a way to add an index section, golang.org-style including a list of files in the package?

Hints:

  • Github markdown supports linking to headers. Adding a link like [Install](#install) should point to the heading anchor on the current markdown document.
  • Github also supports relative linking within the repo from markdown documents. E.g. adding a link like [see the example](example/example.go) to this repo would link to the example file.
@zealws
Copy link

zealws commented Jul 28, 2014

+1 This would be useful, and the resulting output would must more closely match that of the go doc html output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants