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

Add badges to README and remove quickstart #19

Closed ali-ramadhan closed 3 years ago

ali-ramadhan commented 3 years ago

This PR adds some badges, most importantly documentation badges, to the README and removes the quickstart section as it's better formatted in the documentation (and so we don't have to maintain two quickstarts).

ali-ramadhan commented 3 years ago

I was definitely lazy and copy pasted the badges haha. I can change to Markdown. I think the reason I switched to HTML for badges so we could use <p align="center">.

The tabular format is pretty nice. I guess I try to make the badge names more verbose or self-describing to achieve a similar effect.

charleskawczynski commented 3 years ago

I was definitely lazy and copy pasted the badges haha. I can change to Markdown. I think the reason I switched to HTML for badges so we could use <p align="center">.

The tabular format is pretty nice. I guess I try to make the badge names more verbose or self-describing to achieve a similar effect.

I still see this as an improvement over the existing readme, so I'm fine with merging this. I did leave a comment on the doc link, which I think needs to be changed.

ali-ramadhan commented 3 years ago

Changed the link back to stable which should work when we tag the next release, and added a badge for the GHA documentation build.