announcements 2022-05-05

borkdude18:05:39

Announcing quickdoc, a minimal and fast API documentation tool. It spits out a pure markdown API.md file (no CSS or JS) in your project based on what clj-kondo finds. It's very fast when invoked using babashka. It can also be used from the JVM as a Clojure tool: clj -Tquickdoc. The output looks like this: • https://github.com/babashka/fs/blob/master/API.md • https://github.com/babashka/process/blob/master/API.md Repo: https://github.com/borkdude/quickdoc

🎉 37

👍 3

nottmey18:05:40

Is there any reason not to use it? :star-struck:

borkdude18:05:41

@U3ZG4CAF8 I've only tested it on two projects so far, I'm sure there will be some things that need improving :) But the code is very small, so it should be doable to tweak and contribute.

nottmey21:05:05

It’s a nice simple approach, and feels natural to developers browsing the github repo page anyway. I like the approach. :thumbsup: I’ll try it out ☺️

borkdude11:05:48

Now it also supports collapsing namespaces and vars: https://github.com/babashka/sci/blob/master/API.md

🤯 1

bhaim12305:05:49

Execution error (ExceptionInfo) at clojure.tools.deps.alpha.extensions.git/eval1404$fn (git.clj:74).
Library io.github.borkdude/quickdoc has prefix sha, use full sha or add tag

I get it when I try to install with clj

borkdude06:05:26

Like the error says, you need to use the full sha

🙃 1

borkdude19:05:13

For people interested in using #quickdoc, I now made a channel: #quickdoc

2022-05-05

Channels