https://github.com/tatut/nrepl-doc-inject

NREPL middleware to inject community docstrings
https://github.com/tatut/nrepl-doc-inject

clojure documentation

Last synced: about 1 year ago
JSON representation

NREPL middleware to inject community docstrings

• Host: GitHub
• URL: https://github.com/tatut/nrepl-doc-inject
• Owner: tatut
• License: epl-1.0
• Created: 2017-10-04T14:19:02.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-10-04T16:48:19.000Z (over 8 years ago)
• Last Synced: 2025-03-24T09:11:34.232Z (about 1 year ago)
• Topics: clojure, documentation
• Language: Clojure
• Homepage:
• Size: 165 KB
• Stars: 12
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# nrepl-doc-inject

[![CircleCI](https://circleci.com/gh/tatut/nrepl-doc-inject.svg?style=svg)](https://circleci.com/gh/tatut/nrepl-doc-inject) ![PR welcome](https://img.shields.io/badge/pull%20requests-welcome-green.svg)

My stab at improving Clojure docstrings. NREPL middleware to load community

docstrings and inject them.

# How to use

* Clone this and `lein install` it (not on clojars yet)

* Add dependency to project dev or user profile `[nrepl-doc-inject "0.1-SNAPSHOT"]`

* Add middleware to :repl-options / :nrepl-middleware

```clojure

(defproject your-project "version"

  ;; deps etc

  :profiles {:dev {:dependencies [[nrepl-doc-inject "0.1-SNAPSHOT"]]}}

  :repl-options {:nrepl-middleware [nrepl-doc-inject.core/doc-middleware]})

```

![use in cider](https://raw.githubusercontent.com/tatut/nrepl-doc-inject/master/images/reify.png)

# How to contribute

All namespace vars are in the same file under `docs` folder with the `.edn` suffix.

Add new documentation for functions or totally new namespaces.

Send PRs.