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

Support for custom citation and bibliography styles #22

Open simonbyrne opened 4 years ago

simonbyrne commented 4 years ago

Would be useful to be able to customize how the citation and bibliographies are printed.

ali-ramadhan commented 4 years ago

I guess we can implement a few styles (ones we want to use) from

https://www.overleaf.com/learn/latex/Bibtex_bibliography_styles https://www.overleaf.com/learn/latex/Natbib_bibliography_styles https://www.overleaf.com/learn/latex/Biblatex_bibliography_styles

and if someone wants a specific (official?) style they can open a PR with an implementation?

We can also add a section in the docs showing how to define custom styles.

kellertuer commented 3 years ago

Maybe it would be easiest to support CSL for styles?

https://github.com/citation-style-language/styles

Azzaare commented 3 years ago

Import/export from/to CSL in Bibliography.jl is in the todo list of this summer. I will be back to you once it is done!

fingolfin commented 3 years ago

We'd also love to be able to print additional data. E.g. Math papers often have MathSciNet and Zentralblatt reviews, which we'd like to link to; or show the DOI; etc.

goerz commented 1 year ago

The newly released DocumenterCitations.jl v1.0 provides a larger range of citation styles, including a new default numeric style.

The updated version also allows defining completely custom styles, as described in the documentation; although the methods for this are considered internal, and thus not part of the stable API.

Support for general CSL styles seems like it could be an attractive feature and is being tracked in https://github.com/JuliaDocs/DocumenterCitations.jl/issues/13

kellertuer commented 1 year ago

Thanks for the follow up :) I am eager to try this out, since I have been through a few different ways of citations by now in my docs and would love to find one that fits even better than the current ones.

edit: It even covers my favourite way of having a references section per documentation page (yay!) – I will definetly try this out!