r-lib / pkgdown

Generate static html documentation for an R package
https://pkgdown.r-lib.org/
Other
714 stars 334 forks source link

Parse and display citations #295

Closed edzer closed 7 years ago

edzer commented 7 years ago

It would be nice if pkgdown would also process inst/CITATION, e.g. as a fourth item next to Reference Articles Citation

jayhesselberth commented 7 years ago

Not sure it deserves its own page. Could be in the sidebar on the main page e.g. Links, License, Developers, Citation.

edzer commented 7 years ago

Either way!

jayhesselberth commented 7 years ago

Actually probably the best place is on the current authors.html page, where there is fair bit of open space. Not sure an entire citation would fit in the sidebar.

yiluheihei commented 7 years ago

Citations can be displayed in the sidebar, probably configuration options can be supported in config.yaml to order the elements of sidebar for users (e.g. Links, License, Developers, Citation). Or, it can be added to the last section of home page.

jayhesselberth commented 7 years ago

Saw this: https://github.com/ropensci/unconf17/issues/46.

I was thinking all along that a DOI / zenodo badge would be useful, but it's not a required part of the CITATION file. Not sure what a sensible default would be.