Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow arbitrary link texts #63

Closed
goerz opened this issue Mar 5, 2023 · 1 comment
Closed

Allow arbitrary link texts #63

goerz opened this issue Mar 5, 2023 · 1 comment

Comments

@goerz
Copy link

goerz commented Mar 5, 2023

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 goerz mentioned this issue Mar 5, 2023
Closed
@goerz goerz closed this as completed Jul 12, 2023
@goerz
Copy link
Author

goerz commented Jul 12, 2023

Now available in DocumenterCitations 1.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add support for [text](@cite key) syntax
1 participant
@goerz