Liking cljdoc? Tell your friends :D

emmy.portal

Functions for launching portal with Emmy-Viewers-specific viewers installed.

Functions for launching portal with Emmy-Viewers-specific viewers installed.
raw docstring

install!clj

(install!)
(install! path)
(install! path & more)

Given any number of paths, evaluates the cljs file at each path via [[portal.api/eval-str]].

Given no arguments, installs all of the viewers specified in viewers.

Given any number of `path`s, evaluates the `cljs` file at each path
via [[portal.api/eval-str]].

Given no arguments, installs all of the viewers specified in [[viewers]].
sourceraw docstring

prepare!clj

(prepare!)

Installs any npm dependencies specified by a deps.cljs file in some dependency. This will guarantee that the various viewers installed by install! will function.

NOTE: You'll need to call this once when configuring your project, not on each invocation of start!.

Installs any npm dependencies specified by a `deps.cljs` file in some
dependency. This will guarantee that the various viewers installed
by [[install!]] will function.

NOTE: You'll need to call this once when configuring your project, not on each
invocation of [[start!]].
sourceraw docstring

start!clj

(start!)
(start! opts)

Initializes Portal with all project-specific dependencies, calls [[clojure.core/add-tap]] with [[#'portal.api/submit]] and returns the result of [[portal.api/open]].

opts can contain:

  • any Portal option

  • :emmy.portal/tex: optional map of KaTeX options

  • :emmy.portal/mafs: {:theme :default} will assert the default theme for Mafs plots. No other options are currently supported.

Initializes Portal with all project-specific dependencies,
calls [[clojure.core/add-tap]] with [[#'portal.api/submit]] and returns the
result of [[portal.api/open]].

`opts` can contain:

- any [Portal option](https://github.com/djblue/portal#options)

- `:emmy.portal/tex`: optional map of [KaTeX
  options](https://katex.org/docs/options.html)

- `:emmy.portal/mafs`: `{:theme :default}` will assert the default theme for
  Mafs plots. No other options are currently supported.
sourceraw docstring

viewersclj

Vector of paths to the cljs files in this project that declare Portal viewers. Each of these is intended to be evaluated in Portal's SCI context, via [[portal.api/eval-str]].

Vector of paths to the cljs files in this project that declare Portal viewers.
Each of these is intended to be evaluated in Portal's SCI context,
via [[portal.api/eval-str]].
sourceraw docstring

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

× close