screedcast.core
Generate screencast panels.
Generate screencast panels.
*separator*clj
Characters that separate the string representation of the form to be
evaluated and the string representation of the result. Default =>.
Characters that separate the string representation of the form to be evaluated and the string representation of the result. Default ` => `.
*wrap-at*clj
Base-case column wrap, override-able by supplying extra args to the function
that would otherwise consult this value, e.g., prettyfy-form-prettyfy-eval.
Default 80.
Base-case column wrap, override-able by supplying extra args to the function that would otherwise consult this value, e.g., [[prettyfy-form-prettyfy-eval]]. Default `80`.
generate-all-screencastsclj
(generate-all-screencasts opt)Given an options map opt, generate a screencast html doc for all maps
contained by the vector associated to :screencast-filename-bases.
See project documentation for details of the options map.
Given an _options_ map `opt`, generate a screencast html doc for all maps contained by the vector associated to `:screencast-filename-bases`. See [project documentation](https://github.com/blosavio/screedcast) for details of the options map.
panelclj
(panel & hiccups)Returns a screencast panel, with zero or more hiccup forms, including a header and a footer.
Returns a screencast panel, with zero or more hiccup forms, including a header and a footer.
prettyfy-form-prettyfy-evalclj
(prettyfy-form-prettyfy-eval str-form)(prettyfy-form-prettyfy-eval str-form width-fn width-output)Returns a hiccup [:pre [:code]] block wrapping a Clojure stringified form
str-form, then a [:pre [:code]] block wrapping a separator sep
(default ' => '), and evaluated value.
def, defn, s/def/, defmacro, defpred, and require expressions are
only evaled; their output is not captured.
Example:
(prettyfy-form-prettyfy-eval "(inc 99)")
produces this hiccup/html
[:pre [:code.form "(inc 99)"] [:br] [:code.eval ";; => 100"]]
The compiled html elements are manipulated by javascript.
Re-bind *wrap-at* to change base-case column-wrap width. The two optional
width args, width-fn and width-output, supersede this value.
Re-bind *separator* to change the evaluation arrow.
Note: Evaluated output can not contain an anonymous function of either
(fn [x] ...) nor #(...) because zprint requires an internal reference
to attempt a backtrack. Since the rendering of an anonymous function
changes from one invocation to the next, there is no stable reference.
Returns a hiccup `[:pre [:code]]` block wrapping a Clojure stringified form `str-form`, then a `[:pre [:code]]` block wrapping a separator `sep` (default `' => '`), and evaluated value. `def`, `defn`, `s/def/`, `defmacro`, `defpred`, and `require` expressions are only evaled; their output is not captured. Example: ```clojure (prettyfy-form-prettyfy-eval "(inc 99)") ``` produces this hiccup/html ```clojure [:pre [:code.form "(inc 99)"] [:br] [:code.eval ";; => 100"]] ``` The compiled html elements are manipulated by javascript. Re-bind [[*wrap-at*]] to change base-case column-wrap width. The two optional width args, `width-fn` and `width-output`, supersede this value. Re-bind [[*separator*]] to change the evaluation arrow. Note: Evaluated output can not contain an anonymous function of either `(fn [x] ...)` nor `#(...)` because zprint requires an internal reference to attempt a backtrack. Since the rendering of an anonymous function changes from one invocation to the next, there is no stable reference.
screencast-titleclj
(screencast-title idx screencast-title)Construct a screencast title element from index idx and topic
screencast-title.
Construct a screencast title element from index `idx` and topic `screencast-title`.
whats-next-panelclj
(whats-next-panel idx & notes)Returns a 'What's next' panel, with the next idx screencast highlighted,
optional presentation notes to be appended.
Returns a 'What's next' panel, with the next `idx` screencast highlighted, optional presentation `notes` to be appended.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close