# When the :doc-color dynamic binding referenced by *doc-color* is truthy, # the doc-format function replaces a minimal subset of Markdown markup with # the corresponding ANSI escape codes. # # The following markup is supported: # - *this will be underlined* # - **this will be bold** # - `(+ 1 2 3)` <- backticks for code # # You may be surprised by *underline* since the same markup is used to # indicate italics in Markdown. This is likely a tradeoff for compatibility; # historically, the italic attribute has not been widely supported by # terminal emulators. # # The best way to see the effect of *doc-color* is try the following examples # in the Janet REPL. # By default, *doc-color* is enabled. (print (doc-format "*underline*. **bold**. `(code)`.")) # Set the dynamic binding to a falsy value to disable doc-format's ANSI # escape code substition. (with-dyns [*doc-color* false] (print (doc-format "*underline*. **bold**. `(code)`."))) # N.B.: At the time of writing, no docstrings in the core API take advantage of # the bold or underline markup As a result, you may not see any difference in # the doc formatting if your terminal theme uses the same hue for white and # bright white (a few terminals that I tested on Linux make no distinction # between the two colors in their default configuration).