Skip to content

Commit 00a2e42

Browse files
committed
fix merge conflict
2 parents a4f6f64 + a6b8644 commit 00a2e42

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

scripts/markdownlint/custom_rules/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,20 @@ Examples of invalid links:
3434
This custom rule is used to check that every heading has a custom anchor tag.
3535
This is necessary for our LLM translation system to ensure that linking works.
3636

37-
Examples of invalid headings:
37+
Examples of valid headings:
3838

3939
```markdown
40-
## An H2 heading
40+
## An H2 heading {#an-h2-heading}
4141

42-
### An H3 heading
42+
### An H3 heading {#an-h3-heading}
4343
```
4444

45-
Examples of valid headings:
45+
Examples of invalid headings:
4646

4747
```markdown
48-
## An H2 heading {#an-h2-heading}
48+
## An H2 heading
4949

50-
### An H3 heading {#an-h3-heading}
50+
### An H3 heading
5151
```
5252

5353
## no_markdown_image_tags
@@ -57,16 +57,16 @@ markdown image declarations using the `![]()` syntax and prefer to use a
5757
specific image component instead. This rule checks that markdown images are not
5858
used.
5959

60-
Example of an invalid usage:
60+
Example of a valid usage:
6161

6262
```markdown
63-
![An image](/path/to/an/image.png)
63+
import image from '@site/static/images/image.png'
64+
65+
<img src={image} alt="Description"/>
6466
```
6567

66-
Valid usage:
68+
Example of an invalid usage:
6769

6870
```markdown
69-
import image from '@site/static/images/image.png'
70-
71-
<img src={image} alt="Description"/>
72-
```
71+
![An image](/path/to/an/image.png)
72+
```

0 commit comments

Comments
 (0)