Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Linkable Code References #123
I am using jsdoc-to-markdown (ver: 3.0.0) to document the API in my project: https://astx-redux-util.js.org/1.0.0/.
Initially, my code references (function return types, and parameter types) were NOT linkable. These references were coded as follows (out-of-the-box):
My understanding of why this is not linkable, is that markdown does not honor a hyperlink inside a code block (i.e. the
I created a custom partial of
With this enhancement, the references are linkable!
This seems so basic that I can't believe it is a bug. Am I missing something? If not, I believe this change should be incorporated in your library.
FYI: My markdown is interpreted through GitBook. Not sure if that is a variable in the equation or not.
BTW: Great Library!
there are so many different markdown parsers - all the main sites use different ones.. when you see oddities in the partials like
Maybe it's time to review all the partials against the latest versions of the various markdown parsers, but for now they may be ugly but they work..