This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
- # announcements (2)
- # beginners (82)
- # calva (13)
- # cider (12)
- # clara (4)
- # cljdoc (22)
- # clojure (89)
- # clojure-dev (23)
- # clojure-europe (16)
- # clojure-italy (39)
- # clojure-nl (8)
- # clojure-spec (28)
- # clojure-uk (36)
- # clojurescript (40)
- # cursive (10)
- # data-science (1)
- # datomic (27)
- # devcards (4)
- # emacs (1)
- # fulcro (25)
- # jobs (1)
- # jobs-discuss (3)
- # kaocha (5)
- # luminus (1)
- # nrepl (68)
- # off-topic (64)
- # pedestal (23)
- # planck (1)
- # quil (4)
- # re-frame (6)
- # reitit (5)
- # remote-jobs (4)
- # shadow-cljs (16)
- # spacemacs (11)
- # testing (1)
@seancorfield fyi you can also link to the latest version with a much shorter link like this: https://cljdoc.org/d/seancorfield/next.jdbc
This will automatically redirect to the first article at the latest RELEASE version
Yeah, but that doesn't show up in the browser address bar for easy copy'n'pasting 🙂
That's true, just wanted to mention it in case the long links bothered you 😄
Why does this URL show the Alpha 9 readme? https://cljdoc.org/d/seancorfield/next.jdbc/1.0.0-alpha5/doc/readme - it doesn't! But the readme includes badges that are dynamic and therefore confusingly show the current version 😐
I guess I'll have to add text to the README to make that less confusing... Does anyone run into this? Or have suggestions to make it less confusing?
Happy to consider ideas to make this less confusing - we can do whatever with the articles. We could just remove the badge if it’s there but not sure if that’s such a great idea
Oh right, Asciidoc already has a solution
would it be less confusing if the badge just said "cljdoc" without the version number?
right that may also be an option, given that it generally links to the latest version anyways
For now, I changed my README to say
Since I do a find&replace for the version number everywhere in the project before I build each release, this will work for now (well, whenever I get around to cutting the next release it will start working on cljdoc 🙂 )
The latest versions on Clojars and on cljdoc: <<badges go here>> This documentation is for 1.0.0-alpha9.
cool 🙂 asciidoc is pretty nice on cljdoc as well, just FYI: https://cljdoc.org/d/nrepl/nrepl/0.6.0/doc/usage/server
But it's fairly common for project READMEs to contain the Clojars badge (and possibly other version-specific dynamic badges) so I think some sort of rewriting is going to be needed ...
Does GitHub know how to render a README written in AsciiDoc?
just click the github link in the top right corner of the nrepl docs and you can see what that looks like (or the edit on github link at the end of the page I linked)
OK, maybe I will do that then (it'll make me learn it at long last 🙂 )
Oh, and the badge thing... https://cljdoc.org/d/nrepl/nrepl/0.5.3/doc/readme
nREPL's README is markdown, not adoc, BTW.
The callouts with tips, warnings and all that are super nice