Liking cljdoc? Tell your friends :D

notespace

Notebook experience in your Clojure namespace

Clojars Project

What does it mean?

Stay tuned -- a screencast is coming soon.

Examples

Status

Experimental

Goals

  • Use any Clojure namespace, in any Clojure editor, as a notebook
    • [x] editing is done in your beloved editor
    • [x] rendering is done at the browser
    • [ ] typical workflow has almost zero latency in namespace evaluation
  • Live reload experience
    • [ ] re-rendering of relevant notebook part(s)
  • A nootebook is a sequence of notes
    • [x] a note represents a piece of computation and its output
    • [x] any note can be rendered independently
    • [x] the notebook's rendering is the concatenation of its notes' renderings
    • [x] a notes' rendering can depend on its code and its output
    • [x] the precise way it depends on them is configurable in an extensible way
    • [ ] a notes' rendering can depend on the stdout and stderr of its computation
    • [x] we remember notes' last rendering
    • [ ] we know if notes need a refresh (after code change)
  • Everything can be a note
    • [x] function definition
    • [x] test
    • [x] code example
    • [x] data analysis
  • But nothing has to be a note
  • Different modes of refresh
    • [ ] Oz-like refresh-downwards-from-this-note
    • [x] refresh-this-note
    • [x] refresh-everything

License

Copyright © 2019 Scicloj

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close