Skip to content

Commit

Permalink
Document transformations
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 Sep 6, 2024
1 parent 966db85 commit c143d88
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/transformer.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,29 @@ The end marker is:
<!-- INTERACTIVE page <FILENAME> END -->
```

## Transformations

The Grafana documentation source uses some syntax that isn't supported by Killercoda.
The transformer tool transforms some Grafana documentation syntax into equivalent Killercoda Markdown.

The transformer tool transforms the following syntax:

### `figure` shortcode

The tool transforms the [`figure` shortcode](https://grafana.com/docs/writers-toolkit/write/shortcodes/#figure) into an inline Markdown image.

The following Grafana documentation source:

```markdown
{{< figure src="<URL>" alt="<ALT TEXT" >}}
```

becomes the following Killercoda Markdown:

```markdown
![<ALT TEXT](URL)
```

## Generate a tutorial

<!-- vale Grafana.Timeless = NO -->
Expand Down

0 comments on commit c143d88

Please sign in to comment.