{"id":23100782,"url":"https://github.com/p3r7/clojure-essential-ref","last_synced_at":"2025-08-16T14:31:59.967Z","repository":{"id":92559396,"uuid":"269317934","full_name":"p3r7/clojure-essential-ref","owner":"p3r7","description":"🔖 cider-doc to \"Clojure, The Essential Reference\"","archived":false,"fork":false,"pushed_at":"2022-12-15T14:27:51.000Z","size":82,"stargazers_count":47,"open_issues_count":0,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-16T03:51:07.864Z","etag":null,"topics":["cider","clojure","documentation","emacs"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","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/p3r7.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-04T09:35:55.000Z","updated_at":"2025-02-06T19:22:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"a7a27e34-5909-4901-8614-efed7472c306","html_url":"https://github.com/p3r7/clojure-essential-ref","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/p3r7/clojure-essential-ref","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p3r7%2Fclojure-essential-ref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p3r7%2Fclojure-essential-ref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p3r7%2Fclojure-essential-ref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p3r7%2Fclojure-essential-ref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/p3r7","download_url":"https://codeload.github.com/p3r7/clojure-essential-ref/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p3r7%2Fclojure-essential-ref/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270723216,"owners_count":24634340,"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-08-16T02:00:11.002Z","response_time":91,"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":["cider","clojure","documentation","emacs"],"created_at":"2024-12-16T23:35:17.039Z","updated_at":"2025-08-16T14:31:59.947Z","avatar_url":"https://github.com/p3r7.png","language":"Emacs Lisp","funding_links":[],"categories":[],"sub_categories":[],"readme":"# clojure-essential-ref\n\nEmacs packages providing commands to browse the Clojure documentation of a symbol in book [Clojure, The Essential Reference](https://livebook.manning.com/book/clojure-the-essential-reference/):\n\n - `clojure-essential-ref`: browse the default way (see _Configuration_)\n - `clojure-essential-ref-web`: browse online in the web version of the book (_liveBook_)\n - `clojure-essential-ref-nov`: browse offline in a local ebook (provided by optional sibling package `clojure-essential-ref-nov`, depends on [nov.el](https://depp.brause.cc/nov.el/))\n\nThey require a CIDER session to be launched to perform fully-qualified symbol resolution. Likewise, the source file must be known to CIDER. So, when adding a new source file during interactive development your might need to re-evaluate a `require` of this source file or even `cider-eval-buffer` it.\n\nThey behave similarly to `cider-clojuredocs-web`, including the default proposal of _symbol-at-point_. They are a nice companion to the latter (alongside `cider-doc`).\n\nFor more context, read the [accompanying blog post](https://www.eigenbahn.com/2020/06/04/emacs-clojure-essential-ref).\n\n\n## Installation\n\nTo get only the web browsing mode:\n\n```el\n(use-package clojure-essential-ref)\n```\n\n[![MELPA](https://melpa.org/packages/clojure-essential-ref-badge.svg)](https://melpa.org/#/clojure-essential-ref)\n[![MELPA Stable](https://stable.melpa.org/packages/clojure-essential-ref-badge.svg)](https://stable.melpa.org/#/clojure-essential-ref)\n\nTo also get the offline ebook browsing mode (depends on [nov.el](https://depp.brause.cc/nov.el/)):\n\n```el\n(use-package clojure-essential-ref-nov\n  :init\n  (setq clojure-essential-ref-nov-epub-path \"~/Downloads/Clojure_The_Essential_Reference_v29_MEAP.epub\"))\n```\n\n[![MELPA](https://melpa.org/packages/clojure-essential-ref-nov-badge.svg)](https://melpa.org/#/clojure-essential-ref-nov)\n[![MELPA Stable](https://stable.melpa.org/packages/clojure-essential-ref-nov-badge.svg)](https://stable.melpa.org/#/clojure-essential-ref-nov)\n\n## Configuration\n\n#### ebook file\n\nThe offline ebook browing mode needs you to configure the path to the book (EPUB format):\n\n```el\n(use-package clojure-essential-ref-nov\n  ;; ...\n\n  :init\n  (setq clojure-essential-ref-nov-epub-path \"~/Downloads/Clojure_The_Essential_Reference_v29_MEAP.epub\")\n```\n\n#### Default browsing mode\n\nThe default browing mode (command `clojure-essential-ref`) is the online _liveBook_.\n\nTo use the offline ebook browing mode instead:\n\n```el\n(use-package clojure-essential-ref-nov\n  ;; ...\n\n  :init\n  (setq clojure-essential-ref-default-browse-fn #'clojure-essential-ref-nov-browse)\n```\n\n\n## Usage\n\nUnder a CIDER session, just call the command:\n\n    M-x clojure-essential-ref\n\nFor convenience sake, you can bind it to a keyboard shortcut:\n\n```el\n(use-package clojure-essential-ref\n  ;; ...\n  :bind (\n         :map cider-mode-map\n         (\"C-h F\" . clojure-essential-ref)\n         :map cider-repl-mode-map\n         (\"C-h F\" . clojure-essential-ref)))\n```\n\n\n## Legibility\n\nThis code uses form feeds (`^L` character) as separators.\n\nEither package [form-feed](https://github.com/wasamasa/form-feed) or [page-break-lines](https://github.com/purcell/page-break-lines) makes them appear as intended.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fp3r7%2Fclojure-essential-ref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fp3r7%2Fclojure-essential-ref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fp3r7%2Fclojure-essential-ref/lists"}