hegemonic / jsdoc-baseline

An experimental, extensible template for JSDoc.
Other
61 stars 32 forks source link

jsdoc-baseline to point to source at GitHub #178

Open peter-lyons-kehl opened 8 years ago

peter-lyons-kehl commented 8 years ago

Hi Jeff,

An API is less likely to change than its implementation. Unless developers hook their commits to generating & publishing the API, the prettyfied source code gets out of date. Hence, readers of API would benefit, if for GitHub-hosted projects the API would link to prettyfied source code on GitHub. Could you add an option for that, please.

Additionally, users may want to run jsdoc-baseline on several related projects together. Therefore it should be configurable with a mapping {local-source-code-folder: GitHub URL prefix} to point across multiple GitHub projects.

Ideally, could you make the pretty-source-code pointing code extensible, so this could also work for BitBucket or GitLab.

(I looked at jsdoc-baseline, but I don't know where to start with this - whether in linkToLine() or elsewhere.)