Skip to content

Commit

Permalink
Add asciidoctor example to badges
Browse files Browse the repository at this point in the history
  • Loading branch information
SevereOverfl0w authored and martinklepsch committed Nov 2, 2019
1 parent af1c2c3 commit cdaa9be
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion doc/userguide/for-library-authors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,20 @@ https://cljdoc.org/d/$group-id/$artifact-id/CURRENT
https://cljdoc.org/badge/$group-id/$artifact-id
----

In full it may look like this:
In full it may look like this for markdown:

[source,markdown]
----
[![cljdoc badge](https://cljdoc.org/badge/manifold/manifold)](https://cljdoc.org/d/manifold/manifold/CURRENT)
----

or this for asciidoctor:

[source,asciidoctor]
----
image::https://cljdoc.org/badge/manifold/manifold[cljdoc badge, link=https://cljdoc.org/d/manifold/manifold/CURRENT]
----

link:https://cljdoc.org/d/manifold/manifold/CURRENT[image:https://cljdoc.org/badge/manifold/manifold[cljdoc badge]]

IMPORTANT: In the cljdoc URLs above `$group-id` and `$artifact-id` always refer to the Clojars/Maven group/artifact ID, not e.g. GitHub's owner/repo names.
Expand Down

0 comments on commit cdaa9be

Please sign in to comment.