How to use Markdown reference links with Documenter.jl

General Usage
,
1

I usually use Markdown reference links quite often in Markdown files for documentation, e.g. to write:

CellArrays relies on [StaticArrays.jl], [Adapt.jl] and the Julia GPU packages [CUDA.jl] and [AMDGPU.jl]. [StaticArrays.jl] is required ....

Then, I have the reference links a single time, nicely grouped and easy updatable at the end of the document:

[Adapt.jl]: https://github.com/JuliaGPU/Adapt.jl
[AMDGPU.jl]: https://github.com/JuliaGPU/AMDGPU.jl
[CellArrays.jl]: https://github.com/omlins/CellArrays.jl
[CUDA.jl]: https://github.com/JuliaGPU/CUDA.jl
[StaticArrays.jl]: https://github.com/JuliaArrays/StaticArrays.jl

With Documentor.jl these reference links are however not expanded. Does anybody have a solution for this?

3 Likes
2

The Julia Markdown parser unfortunately does not support reference links and so they’re unavailable with Documenter (essentially, it’s not valid/meaningful Julia Flavored Markdown). I do hope to get CommonMark support into Documenter at some point, which does support them.

1 Like
3

Do you think a patch to Julia flavoured markdown that implements this would be accepted?
It already has similar (and very nice) footnote syntax.