Markdown reference style links
Reference links in markdown work quite differently from regular links. The basic link is similar, but just with square brackets for both text and the link name:
[our example text][link name]
then we need to define the id somewhere else in our document (I usually do it at the end of the document to make it easier to find) and we can also add a title there in either quotation marks ("
) or round brackets and it will appear when hovering over the link.
[id]: https://mdtx.cloud/ 'link title'
This is especially useful for sourced text where you can simply specify the sources with id 1-10 at the bottom of the page and then call them via [id1]
wherever you need. Alternatively you can also use something more descriptive than [id1]
, like for example [homepage]
, which will save you some time on writing link descriptions
Head on over to our [homepage][] check our [docs][] or log into the [app][].
[homepage]: http://google.com/ 'Google'
[docs]: https://mdtx.cloud/docs/home 'MDTX docs'
[app]: http://search.msn.com/ 'Log in'
Which will result in:
Head on over to our homepage check our docs or log into the app.