Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document docs/ignore shortcode #770

Merged
merged 3 commits into from
Jul 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/sources/write/shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,37 @@ Produces:

{{< docs/experimental product="experimental-feature" featureFlag="its-feature-flag" >}}

## Docs/ignore

The `docs/ignore` shortcode ignores the content between the start and end markers so it doesn't appear in the rendered webpage.

Use this shortcode when you want to transform source documentation into Killercoda tutorials and want some content to only exist in the tutorial output.
jdbaldry marked this conversation as resolved.
Show resolved Hide resolved
You should only use ordinary Markdown as the inner content of the shortcode.

For more information about Killercoda transformation, refer to [About the transformer tool](https://github.com/grafana/killercoda/blob/staging/docs/transformer.md#about-the-transformer-tool).

### Example

```markdown
This is rendered before the ignore.

{{</* docs/ignore */>}}
This isn't rendered.
{{</* /docs/ignore */>}}

This is rendered after the ignore.
```

Produces:

This is rendered before the ignore.

{{< docs/ignore >}}
This isn't rendered.
{{< /docs/ignore >}}

This is rendered after the ignore.

## Docs/play

The `docs/play` shortcode produces a note admonition with the preferred copy for linking to a Grafana Play dashboard.
Expand Down