elastic / elastic/crd-ref-docs

Code blocks in the descriptions are not properly rendered

Open
#168 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

In our case we have inside our description for a field embedded code blocks as examples

For e.g. the following code block in the description.

```
// Examples:
// * To get .....
//
// ```
// propFoo:
// stage: "X"
// wait: "y"
// ```
//

```

The rendering of this is broken , and does not produce the expected output like

>
> Examples:
> * To get .....
>
> ```
> propFoo:
> stage: "X"
> wait: "y"
> ```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.