{"id":15636510,"url":"https://github.com/borkdude/quickdoc","last_synced_at":"2025-03-02T22:13:36.167Z","repository":{"id":38783830,"uuid":"489047118","full_name":"borkdude/quickdoc","owner":"borkdude","description":"Quick and minimal API doc generation for Clojure","archived":false,"fork":false,"pushed_at":"2024-08-30T14:52:59.000Z","size":76,"stargazers_count":126,"open_issues_count":2,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-23T21:12:01.495Z","etag":null,"topics":["babashka","clj-kondo","clojure"],"latest_commit_sha":null,"homepage":"","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/borkdude.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"borkdude"}},"created_at":"2022-05-05T16:25:37.000Z","updated_at":"2024-09-16T05:41:03.000Z","dependencies_parsed_at":"2024-01-23T22:05:06.856Z","dependency_job_id":"f901ce60-6c97-4b23-ac21-1be5c28c857a","html_url":"https://github.com/borkdude/quickdoc","commit_stats":{"total_commits":115,"total_committers":7,"mean_commits":"16.428571428571427","dds":"0.060869565217391286","last_synced_commit":"3aad5fde31c30bdb84554ff5d2d0263fd1743f04"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borkdude%2Fquickdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borkdude%2Fquickdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borkdude%2Fquickdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/borkdude%2Fquickdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/borkdude","download_url":"https://codeload.github.com/borkdude/quickdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241577090,"owners_count":19984941,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["babashka","clj-kondo","clojure"],"created_at":"2024-10-03T11:04:35.142Z","updated_at":"2025-03-02T22:13:36.138Z","avatar_url":"https://github.com/borkdude.png","language":"Clojure","funding_links":["https://github.com/sponsors/borkdude"],"categories":["Clojure"],"sub_categories":[],"readme":"# Quickdoc\n\n## API docs\n\nSee [API.md](API.md).\n\n## Rationale\n\nThis library came out of the desire to have a fast and light weight tool that\nproduces API docs from any Clojure code (`.clj`, `.cljs`, `.cljc`) without\nexecuting that code. This tool produces pure Markdown that you can read directly\non Github and the output does not need CSS or JavaScript.\n\nQuickdoc's properties:\n\n- Based on [clj-kondo static analysis](https://github.com/clj-kondo/clj-kondo/tree/master/analysis)\n- Fast to run using [babashka](#babashka) (around 100ms for this project)\n\n## Projects using quickdoc\n\n- [fs](https://github.com/babashka/fs/blob/master/API.md)\n- [process](https://github.com/babashka/process/blob/master/API.md)\n- [quickdoc](https://github.com/borkdude/quickdoc/blob/main/API.md)\n- [SCI](https://github.com/babashka/sci/blob/master/API.md)\n\n## Status\n\nThis project is just getting started. Therefore the API may still undergo\nsignificant changes based on early usage and feedback.\n\n## Babashka\n\n### task\n\nUse as a babashka dependency and task:\n\n``` clojure\n# bb.edn\n:tasks {\n,,,\nquickdoc {:doc \"Invoke quickdoc\"\n          :extra-deps {io.github.borkdude/quickdoc {:git/sha \"7c8bef54eda28367193ec433af01bb940114f012\"}}\n          :task (exec 'quickdoc.api/quickdoc)\n          :exec-args {:git/branch \"master\"\n                      :github/repo \"https://github.com/clj-kondo/clj-kondo\"\n                      :source-paths [\"src/clj_kondo/core.clj\"]}}\n,,,\n}\n```\n\nNow you can run `bb quickdoc` and your API docs will be generated in `API.md`.\n\n### bbin\n\nInstall via [bbin](https://github.com/babashka/bbin):\n\n```\nbbin install io.github.borkdude/quickdoc --as quickdoc\n```\n\n## Clojure CLI\n\nAdd the following alias to your global or project-local `deps.edn`:\n\n``` clojure\n:aliases {\n,,,\n:quickdoc\n{:deps {org.babashka/cli {:mvn/version \"0.4.36\"}\n        io.github.borkdude/quickdoc\n        {:deps/root \"jvm\"\n         :git/sha \"7c8bef54eda28367193ec433af01bb940114f012\"}}\n :main-opts [\"-m\" \"babashka.cli.exec\" \"quickdoc.api\" \"quickdoc\"]}\n,,,\n}\n```\n\nThen you can call quickdoc using:\n\n``` clojure\nclj -M:quickdoc :github/repo https://github.com/clj-kondo :git/branch master\n```\n\nYou can add default arguments to `:exec-args` in the alias:\n\n``` clojure\n:quickdoc\n{,,,\n :exec-args {:github/repo \"https://github.com/clj-kondo\"\n             :git/branch \"master\"}\n```\n\nSo the command line invocation simply becomes:\n\n``` clojure\nclj -M:quickdoc\n```\n\n## Clojure tool\n\nQuickdoc is also available as a [clj\ntool](https://clojure.org/reference/deps_and_cli#_tool_usage). Note that this\nway of invoking quickdoc is slower to start than with babashka.\n\nTo install, run:\n\n```\nclj -Ttools install io.github.borkdude/quickdoc '{:deps/root \"jvm\" :git/sha \"\u003clatest-sha\u003e\"}' :as quickdoc\n```\n\nThen invoke quickdoc using:\n\n```\nclj -Tquickdoc quickdoc '{:github/repo \"https://github.com/borkdude/quickdoc\"}'\n```\n\n## Can it be improved to do ...?\n\nProbably yes! Let me know in [Github Discussions](https://github.com/borkdude/quickdoc/discussions) or create an [issue](https://github.com/borkdude/quickdoc/issues).\n\n## License\n\nSee [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborkdude%2Fquickdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fborkdude%2Fquickdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fborkdude%2Fquickdoc/lists"}