jsdoc-to-markdown icon indicating copy to clipboard operation
jsdoc-to-markdown copied to clipboard

Link to source file

Open Anthony-Gaudino opened this issue 4 years ago • 1 comments

Is it possible to add a link in the generated Markdown pointing to the source file?

My idea is to make it easy for who is looking at the documentation to open the source and see the code.

It would be even better if we could have a link for each function, class, etc. and when the user clicks on this link he will be directed to that specific class, function...

We use GitLab and it's easy to have a link to a file and line, for example: https://domain/repository/-/blob/master/source/code.js#L19 would be line 19 of code.js.

Anthony-Gaudino avatar Nov 30 '21 12:11 Anthony-Gaudino

You'd need to customise the output - did you check the wiki?

75lb avatar Dec 01 '21 09:12 75lb