Skip to content

Commit aab5186

Browse files
committed
update syntax guide
1 parent b8a151b commit aab5186

File tree

2 files changed

+35
-51
lines changed

2 files changed

+35
-51
lines changed

docs/source/syntax/admonitions.md

Lines changed: 34 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,14 @@ Admonitions allow you to highlight important information with varying levels of
77
## Basic admonitions
88

99
Admonitions can span multiple lines and support inline formatting.
10+
Available admonition types include:
1011

11-
`````{tab-set}
12+
- Note
13+
- Warning
14+
- Tip
15+
- Important
1216

13-
````{tab-item} MD Syntax
14-
15-
### Available admonition types
16-
17-
- `note`
18-
- `warning`
19-
- `tip`
20-
- `important`
21-
22-
### Syntax
23-
24-
**Note**
17+
### Note
2518

2619
A relevant piece of information with no serious repercussions if ignored.
2720

@@ -36,7 +29,7 @@ It can span multiple lines and supports inline formatting.
3629
This is a note.
3730
:::
3831

39-
**Warning**
32+
### Warning
4033

4134
You could permanently lose data or leak sensitive information.
4235

@@ -50,7 +43,7 @@ This is a warning.
5043
This is a warning.
5144
```
5245

53-
**Tip**
46+
### Tip
5447

5548
Advice to help users make better choices when using a feature.
5649

@@ -64,7 +57,7 @@ This is a tip.
6457
This is a tip.
6558
```
6659

67-
**Important**
60+
### Important
6861

6962
Ignoring this information could impact performance or the stability of your system.
7063

@@ -78,43 +71,11 @@ This is an important notice.
7871
This is an important notice.
7972
```
8073

81-
````
82-
83-
````{tab-item} Asciidoc Syntax
84-
85-
| **Asciidoc Type** | **When to use it** |
86-
|--------------|-----------------------------------------------------------------------------------|
87-
| **Warning** | You could permanently lose data or leak sensitive information. |
88-
| **Important**| Ignoring the information could impact performance or the stability of your system.|
89-
| **Note** | A relevant piece of information with no serious repercussions if ignored. |
90-
| **Tip** | Advice to help you make better choices when using a feature. |
91-
92-
93-
**Inline Admonition:**
94-
```none
95-
NOTE: This is a note.
96-
It can be multiple lines, but not multiple paragraphs.
97-
```
98-
99-
**Block Admonition:**
100-
101-
```none
102-
[WARNING]
103-
=======
104-
This is a warning.
105-
106-
It can contain multiple paragraphs.
107-
=======
108-
:::
109-
```
110-
111-
`````
112-
11374
## Collapsible admonitions
11475

115-
You can use `:open: <bool>` to make an admonition collapsible.
76+
Use `:open: <bool>` to make an admonition collapsible.
11677

117-
```none
78+
```markdown
11879
:::{note}
11980
:open:
12081

@@ -131,3 +92,26 @@ Longer content can be collapsed to take less space.
13192
13293
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
13394
```
95+
96+
---
97+
98+
## Asciidoc Syntax
99+
100+
### Inline Admonition
101+
102+
```markdown
103+
NOTE: This is a note.
104+
It can be multiple lines, but not multiple paragraphs.
105+
```
106+
107+
### Block Admonition
108+
109+
```markdown
110+
[WARNING]
111+
=======
112+
This is a warning.
113+
114+
It can contain multiple paragraphs.
115+
=======
116+
:::
117+
```

docs/source/syntax/automated_settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Elastic Docs V3 supports the ability to build a markdown settings reference from
66

77
### Syntax
88

9-
```none
9+
```markdown
1010
:::{settings} /syntax/kibana-alerting-action-settings.yml
1111
:::
1212
```

0 commit comments

Comments
 (0)