Skip to content

Commit 6eb96da

Browse files
oxinaboxmortenpi
andauthored
add more about docblocks (#33279)
* add more about docblocks * remove excess whitespace * Update stdlib/Markdown/docs/src/index.md Co-Authored-By: Morten Piibeleht <[email protected]> * Remove instruction on how to style. * Update stdlib/Markdown/docs/src/index.md Co-Authored-By: Morten Piibeleht <[email protected]> Co-authored-by: Morten Piibeleht <[email protected]>
1 parent 55b5776 commit 6eb96da

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

stdlib/Markdown/docs/src/index.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -365,12 +365,21 @@ They can be defined using the following `!!!` syntax:
365365
This warning admonition has a custom title: `"Beware!"`.
366366
```
367367

368-
The type of the admonition can be any word, but some types produce special styling,
369-
namely (in order of decreasing severity): `danger`, `warning`, `info`/`note`, and `tip`.
368+
The type of the admonition can be any word made up of only lowercase Latin characters (a-z), but some types produce special styling,
369+
namely (in order of decreasing severity): `danger`, `warning`, `info`, `note`, and `tip`.
370370

371371
A custom title for the box can be provided as a string (in double quotes) after the admonition type.
372-
If no title text is specified after the admonition type, then the title used will be the type of the block,
373-
i.e. `"Note"` in the case of the `note` admonition.
372+
For that standard types (`danger`, `warning`... etc_, if no title text is specified after the
373+
admonition type, then the type title used will be the type of the block.
374+
E.g. `"Note"` in the case of the `note` admonition.
375+
376+
If you would like to define your own block, for example a `terminology` block
377+
used like so:
378+
```
379+
!!! terminology "julia vs Julia"
380+
Strictly speaking, Julia refers to the language,
381+
and julia the standard implementation.
382+
```
374383

375384
Admonitions, like most other toplevel elements, can contain other toplevel elements.
376385

0 commit comments

Comments
 (0)