This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2022-05-05
Channels
- # announcements (8)
- # babashka (6)
- # beginners (55)
- # biff (8)
- # calva (11)
- # cider (4)
- # clj-kondo (6)
- # cljdoc (23)
- # cljs-dev (22)
- # clojure (89)
- # clojure-brasil (3)
- # clojure-europe (47)
- # clojure-indonesia (1)
- # clojure-nl (1)
- # clojure-spec (3)
- # clojure-uk (5)
- # clojurescript (67)
- # community-development (2)
- # conjure (29)
- # cursive (2)
- # datalog (29)
- # datomic (41)
- # defnpodcast (4)
- # emacs (15)
- # google-cloud (5)
- # holy-lambda (6)
- # hyperfiddle (3)
- # introduce-yourself (8)
- # jobs (1)
- # malli (19)
- # meander (41)
- # nrepl (1)
- # off-topic (30)
- # pathom (22)
- # polylith (30)
- # releases (1)
- # remote-jobs (4)
- # sci (4)
- # shadow-cljs (1)
- # spacemacs (7)
- # specter (3)
- # tools-build (16)
- # tools-deps (2)
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

@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.
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 ☺️
Now it also supports collapsing namespaces and vars: https://github.com/babashka/sci/blob/master/API.md