gomarkdoc
gomarkdoc copied to clipboard
princjef
Generate markdown documentation for Go (golang) code
Fixes #74 Please note, that #76 need to be merged first, than rebase the current one before merging
eg: > [type DList](https://github.com/chen3feng/contalgo/blob/master/README.md#type-dlist) > [func NewDList[T any](https://github.com/chen3feng/contalgo/blob/master) *DList[T]]() See the following link for more examples: https://github.com/chen3feng/contalgo/blob/decca4ca119775b6bed62a1ef5b35e76696f17f3/README.md#index Thanks.
Would be nice to annotate markdown's codeblock with a language such that it would have the correct style on github/gitlab/etc.. As an example the auto generated README from this repo...
Hi, I've noticed that, when generating markdown files with some characters like "*(){}[]-", the output is not correct and backslashes are added to the md file before each of the...
**Use case:** We have a markdown README like: ```markdown # My Project Blah blah blah blah ## API Documentation ``` ... and would like for either the CLI, or preferably...
There are multiple newlines are generated during templates processing which is known behaviour, i.e. ``` func (h *Client) IsReleaseInstalled(...) (bool, error) Generated by [gomarkdoc]() ``` But multiple empty lines for...
The current implementation was stripping out all comments inside the example function, this fixes that behaviour. It also strips out the leading and trailing braces to better match how godoc...
gofmt has a new `#` syntax for inferred headers. see release notes https://go.dev/doc/go1.19#go-doc. support this by not escaping headers beginning with `#` in godoc. example `example.go` ``` // Package example...
I want to generate a relaitive link in the doc to a yaml file that is in the repo istelf. In md I would do: ``` see example: [filename.yaml](./path-to-yaml.yml) ```...
It would be great if this package could support generating docs that are compatible with Pandoc. Currently the major issue seems to be the anchor link before the title, as...
