search

ali-ramadhan / DocumenterCitations.jl

DocumenterCitations.jl uses Bibliography.jl to add support for BibTeX citations and references in documentation pages generated by Documenter.jl.
https://ali-ramadhan.github.io/DocumenterCitations.jl/dev
MIT License
65 stars 10 forks source link

Allow arbitrary link texts #63

Closed goerz closed 1 year ago

goerz commented 1 year ago

Just like Documenter.jl in general supports arbitrary link texts with the syntax [Custom Header](@ref my_custom_header_name), DocumenterCitations.jl should support the syntax [text](@cite key), which simply renders as text.

Especially in docstrings I would often want to include a "manual" list of references, e.g.

# Reference

* [Mayer, Krechetnikov, Phys. Rev. E 85, 046117 (2012)](@cite Mayer2012)

which may also be the underlying motivation of #62. The generalized syntax might also partially address #15 and #32.

goerz commented 1 year ago

Now available in DocumenterCitations 1.0