Skip to content

Commit

Permalink
added documentation about example option with mention of limitations (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
gpoore committed Jul 11, 2022
1 parent e1d9823 commit d39dbac
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,12 @@ session is in use).
defaults to `latex|markdown|png|jpg|svg|plain`. All others default to
`verbatim`.

* `example`={bool} — Insert a code block containing the Markdown source of the
code chunk, followed by the rest of the output as normal. This is only
valid for inline code if the code is in a paragraph by itself. This option
is currently not compatible with `--only-code-output` and Codebraid Preview.
This option is intended primarily for documentation about Codebraid.

#### Copying

* `copy`={chunk name(s)} — Copy one or more named code chunks. When `copy` is
Expand Down

0 comments on commit d39dbac

Please sign in to comment.