Skip to content

Commit

Permalink
Fix #2351 -- mark extending.txt shortcodes raw
Browse files Browse the repository at this point in the history
Signed-off-by: Chris Warrick <kwpolska@gmail.com>
  • Loading branch information
Kwpolska committed May 29, 2016
1 parent da5e94c commit afdfa55
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/extending.txt
Expand Up @@ -557,11 +557,11 @@ Shortcodes

Some (hopefully all) markup compilers support shortcodes in these forms::

{{% foo %}} # No arguments
{{% raw %}}{{% foo %}} # No arguments
{{% foo bar %}} # One argument, containing "bar"
{{% foo bar baz=bat %}} # Two arguments, one containing "bar", one called "baz" containing "bat"

{{% foo %}}Some text{{% /foo %}} # one argument called "data" containing "Some text"
{{% foo %}}Some text{{% /foo %}} # one argument called "data" containing "Some text"{{% /raw %}}

So, if you are creating a plugin that generates markup, it may be a good idea
to register it as a shortcode in addition of to restructured text directive or
Expand Down

0 comments on commit afdfa55

Please sign in to comment.