{"id":34718810,"url":"https://github.com/funcool/boot-codeina","last_synced_at":"2025-12-25T01:28:43.100Z","repository":{"id":32191179,"uuid":"35764706","full_name":"funcool/boot-codeina","owner":"funcool","description":"Beautiful api documentation generator for Clojure.","archived":false,"fork":false,"pushed_at":"2016-06-17T00:26:41.000Z","size":148,"stargazers_count":14,"open_issues_count":3,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-08T19:37:31.871Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/funcool.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-17T12:10:08.000Z","updated_at":"2020-07-30T10:19:07.000Z","dependencies_parsed_at":"2022-08-24T14:23:08.303Z","dependency_job_id":null,"html_url":"https://github.com/funcool/boot-codeina","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/funcool/boot-codeina","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funcool%2Fboot-codeina","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funcool%2Fboot-codeina/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funcool%2Fboot-codeina/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funcool%2Fboot-codeina/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/funcool","download_url":"https://codeload.github.com/funcool/boot-codeina/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funcool%2Fboot-codeina/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28015537,"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","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-12-25T01:28:34.120Z","updated_at":"2025-12-25T01:28:43.094Z","avatar_url":"https://github.com/funcool.png","language":"Clojure","readme":"# boot-codeina\n\n```clojure\n[funcool/boot-codeina \"0.1.0-SNAPSHOT\"]\n```\n\nTasks for generate beautiful api reference documentation for the [boot Clojure build tool][1]\n\n\n## Usage\n\nAdd `boot-codeina` to your `build.boot` dependencies and `require` the namespace:\n\n```clj\n(set-env! :dependencies '[[funcool/boot-codeina \"0.1.0-SNAPSHOT\" :scope \"test\"]])\n(require '[funcool.boot-codeina :refer :all])\n\n(task-options!\n apidoc {:version \"0.1.0\"\n         :title \"MyPackage name\"\n         :sources #{\"src\"}\n         :description \"MyPackage description\"})\n```\n\nAnd now, execute the `apidoc` task:\n\n```bash\n$ boot apidoc\nGenerated HTML docs in /home/user/yourproject/doc/api\n```\n\nYou can get the detailed information passing `-h` parameter to the `apidoc` task:\n\n```bash\n$ boot apidoc -h\nGenerate beautiful api documentation.\n\nOptions:\n  -h, --help              Print this help info.\n  -t, --title TITLE       Set the project title to TITLE.\n  -s, --sources SOURCES   Conj SOURCES onto sources to read.\n  -d, --description DESC  Set the project description to DESC.\n  -v, --version VERSION   Set the project version to VERSION.\n  -i, --include INCLUDE   Conj INCLUDE onto include concrete namespaces.\n  -x, --exclude EXCLUDE   Conj EXCLUDE onto exclude concrete namespaces.\n  -f, --format FORMAT     Set docstring format to FORMAT.\n  -o, --target OUTDIR     Set the output directory to OUTDIR.\n  -n, --root ROOTDIR      Set the project root directory to ROOTDIR.\n  -u, --src-uri SRCURI    Set source code uri to SRCURI.\n  -w, --writer WRITER     Set documentation writer to WRITER.\n  -r, --reader READER     Set source reader to READER.\n```\n\n[1]: https://github.com/boot-clj/boot\n\n\n## Examples ##\n\n- https://funcool.github.io/cats/latest/api/\n- https://funcool.github.io/buddy-auth/latest/api/\n- https://funcool.github.io/catacumba/latest/api/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuncool%2Fboot-codeina","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffuncool%2Fboot-codeina","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffuncool%2Fboot-codeina/lists"}