Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
  • Loading branch information
jdbaldry committed Jul 2, 2024
1 parent 26a8322 commit 9b2f14c
Showing 1 changed file with 2 additions and 36 deletions.
38 changes: 2 additions & 36 deletions docs/transformer.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ Use directives to:
- [Configure executable code blocks](#exec)
- [Define pages](#page)
- [Ignore parts of the documentation](#ignore)
- [Include extra parts not in the website page](#include)

### Exec

Expand Down Expand Up @@ -112,6 +111,8 @@ The end marker is:
<!-- INTERACTIVE ignore END -->
```

To do the inverse task, and ignore content in the website build, use the [`docs/ignore` shortcode](https://grafana.com/docs/writers-toolkit/write/shortcodes/#docs-ignore).

#### Examples

```markdown
Expand All @@ -130,41 +131,6 @@ Produces:
Information common to both pages.
```

### Include

The include directive tells the transform tool to include the contents of the HTML comments within the markers as content when generating the Killercoda page.
The HTML comments aren't rendered on the Grafana website.

The start marker is:

```markdown
<!-- INTERACTIVE include START -->
```

The end marker is:

```markdown
<!-- INTERACTIVE include END -->
```

#### Examples

```markdown
Information common to both pages.
<!-- INTERACTIVE include START -->
<!-- Information unique to the Killercoda page. -->
<!-- INTERACTIVE include END -->
```

Produces:

```markdown
Information common to both pages.
Information unique to the Killercoda page.
```

### Page

The page directive tells the transform tool to use the content between the markers as the source for a Killercoda page.
Expand Down

0 comments on commit 9b2f14c

Please sign in to comment.