Fork me on GitHub

Hello, Is there a way in articles to link vars similarly to what is possible in docstrings?


@jeremys Yes, a link like (from Getting Started) will take the reader direct to that function in the API.


The source of that article has

You can see the full list of `:dbtype` values supported in [next.jdbc/get-datasource]( docstring.


@seancorfield Ok so you create the url yourself, no wikilink magic like in docstings. However the 'CURRENT' part of the url is plenty magic since it seems to resolve to whatever version of the docs you are currently consulting. That's pretty cool. Thanks a lot.


The main reason I use the full URL is because otherwise someone browsing the markdown docs in the GitHub repo would not be able to click on those links.


oh right, I didn't think of that!


I've had plenty of confused feedback from users who were reading the doc folder markdown files directly on GitHub 🙂


And of course, what's on GitHub is the "latest" code and may not have a release yet -- so that's a case where you can't provide a working link from an article to a newly-added function (since the API docs wouldn't have been generated yet). So that's been a constant battle to try to clarify...


True! Still, the CURRENT trick in the url allows the articles and the API docs to be in sync which is pretty neat already.


Another funny problem I am having. When you want to propose deps coordinates for a project using a git sha. You can't have this sha in the version of the readme cljdoc will use. In effect the readme seen on the clj doc's page is one commit behind...


@seancorfield Thanks again for the url scheme, the docs I generate now link even from intellij's markdown viewer...


Re: Git SHA: yeah, you end up needing to do an extra commit where you update just the references to any old SHAs with the latest SHAs.


(so the README essentially always needs to be one commit ahead of the code)