Liking cljdoc? Tell your friends :D

Clojure Notebooks

If you are interested in using Portal as a renderer for Calva's Clojure Notebooks, you've come to the right place.

Before getting started, make sure you have both the Calva and Portal VS Code extensions installed.

Usage

With the above extensions installed, you should now be able to open any Clojure file by right clicking the file in the file explorer and selecting Open With... and selecting Clojure Notebook. The output cells have a three dot menu where you can change the presentation to Portal!

Note Calva gives Portal the evaluation results as an edn string therefore this mode of Portal will not be the same as a process connected Portal instance.

portal.nrepl/wrap-notebook

If you would like the same facilities provided by a process connected Portal instance directly in your Calva notebooks, simply add the portal.nrepl/wrap-notebook middleware to your nrepl stack. This will enable:

  • Datafy + Nav
  • First class object support
  • Runtime registered commands
  • Larger values which are harder for edn to serialize and parse
  • Better error rendering

Can you improve this documentation?Edit on GitHub

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

× close