Liking cljdoc? Tell your friends :D
Clojure only.

std.pretty.color

Coloring multimethods to format text by adding markup.

Color Options

:print-color

When true, ouptut colored text from print functions.

:color-markup

  • :ansi for color terminal text (default)
  • :html-inline for inline-styled html
  • :html-classes for html with semantic classes

:color-scheme

Map of syntax element keywords to color codes.

Coloring multimethods to format text by adding markup.

#### Color Options

`:print-color`

When true, ouptut colored text from print functions.

`:color-markup`

- `:ansi` for color terminal text (default)
- `:html-inline` for inline-styled html
- `:html-classes` for html with semantic classes

`:color-scheme`

Map of syntax element keywords to color codes.
raw docstring

-documentcljmultimethod

Constructs a pretty print document, which may be colored if :print-color is true.

(-document printer/+defaults+ :string "hello there") => [:span [:pass "[36m"] "hello there" [:pass "[0m"]]

(-document printer/+defaults+ :keyword :something) => [:span [:pass "[34m"] :something [:pass "[0m"]]

Constructs a pretty print document, which may be colored if `:print-color` is true.

(-document printer/+defaults+ :string "hello there")
=> [:span [:pass ""] "hello there" [:pass ""]]

(-document printer/+defaults+ :keyword :something)
=> [:span [:pass ""] :something [:pass ""]]
raw docstring

-textcljmultimethod

Produces text colored according to the active color scheme. This is mostly useful to clients which want to produce output which matches data printed by Puget, but which is not directly printed by the library. Note that this function still obeys the :print-color option.

(-text printer/+defaults+ :string "hello there") => "[36mhello there[0m"

(-text printer/+defaults+ :keyword :hello) => "[34m:hello[0m"

Produces text colored according to the active color scheme. This is mostly
useful to clients which want to produce output which matches data printed by
Puget, but which is not directly printed by the library. Note that this
function still obeys the `:print-color` option.

(-text printer/+defaults+ :string "hello there")
=> "hello there"

(-text printer/+defaults+ :keyword :hello)
=> ":hello"
raw docstring

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

× close