https://github.com/roman01la/atom-cljs-doc

ClojureScript core library documentation viewer for Atom
https://github.com/roman01la/atom-cljs-doc

atom atom-cljs-doc clojurescript

Last synced: 20 days ago
JSON representation

ClojureScript core library documentation viewer for Atom

• Host: GitHub
• URL: https://github.com/roman01la/atom-cljs-doc
• Owner: roman01la
• License: mit
• Created: 2016-11-15T11:32:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-08-11T16:50:46.000Z (over 7 years ago)
• Last Synced: 2025-04-14T11:05:19.521Z (20 days ago)
• Topics: atom, atom-cljs-doc, clojurescript
• Language: JavaScript
• Homepage: https://atom.io/packages/atom-cljs-doc
• Size: 519 KB
• Stars: 9
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# atom-cljs-doc package

*ClojureScript core library documentation viewer for Atom*

![atom-cljs-doc usage example gif](https://raw.githubusercontent.com/roman01la/atom-cljs-doc/master/example.gif)

## Installation

Search package installer for `atom-cljs-doc` or use the command line:

```

apm install atom-cljs-doc

```

## Usage

1. Open `.clj`, `.cljs` or `.cljc` file

2. Place text cursor into a form, e.g. `if`

3. Notice a button to the right in a status bar, e.g. `(doc if)`

4. Press it

5. A notification with a doc string will pop up

6. Read it, close or press `Read on ClojureDocs` button to go to documentation website