Liking cljdoc? Tell your friends :D
Clojure only.

screedcast.core

Generate screencast panels.

Generate screencast panels.
raw docstring

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.
raw docstring

generate-screencastclj

(generate-screencast fnbe opt)

Given file-name base entry fnbe and screedcast options map opt, generate an html screencast page.

Given file-name base entry `fnbe` and screedcast options map `opt`, generate
an html screencast page.
raw docstring

generate-tocclj

(generate-toc opt)

Given an options map opt, generate a Table of Contents listing of screencasts hyperlinks. Hyperlink slugs are composed from the screencast filenames.

Within opt,

  • :toc-preamble is hiccup/html displayed above the listing
  • :toc-uuid is a UUID for the TOC webpage
  • :toc-url-base is the leading portion of the url up to the slug (include a trailing slash '/')
Given an _options_ map `opt`, generate a _Table of Contents_ listing of
screencasts hyperlinks. Hyperlink slugs are composed from the screencast
filenames.

Within `opt`,

* `:toc-preamble` is hiccup/html displayed above the listing
* `:toc-uuid` is a UUID for the TOC webpage
* `:toc-url-base` is the leading portion of the url up to the slug (include a
  trailing slash '/')
raw docstring

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.
raw docstring

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 readmoi.core/*wrap-at* to change base-case column-wrap width. The two optional width args, width-fn and width-output, supersede this value.

Re-bind readmoi.core/*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 [`readmoi.core/*wrap-at*`](https://blosavio.github.io/readmoi/readmoi.core.html#var-*wrap-at*)
to change base-case column-wrap width. The two optional width args, `width-fn`
and `width-output`, supersede this value.

Re-bind [`readmoi.core/*separator*`](https://blosavio.github.io/readmoi/readmoi.core.html#var-*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.
raw docstring

screedcast-defaultsclj

A hash-map residing in screedcast_defaults.clj that supplies the default values for the following options keys:

  • :project-license-section
  • :screencast-html-directory
  • :sections-directory
  • :separator
  • :wrap-at
  • :tidy-html?
  • :toc?
A hash-map residing in `screedcast_defaults.clj` that supplies the default
values for the following options keys:

 * `:project-license-section`
 * `:screencast-html-directory`
 * `:sections-directory`
 * `:separator`
 * `:wrap-at`
 * `:tidy-html?`
 * `:toc?`
raw docstring

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`.
raw docstring

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.
raw docstring

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close