Skip to content

Commit d39dbac

Browse files
committed
added documentation about example option with mention of limitations (#56)
1 parent e1d9823 commit d39dbac

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,12 @@ session is in use).
564564
defaults to `latex|markdown|png|jpg|svg|plain`. All others default to
565565
`verbatim`.
566566

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

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

0 commit comments

Comments
 (0)