Skip to content

Commit 567cab3

Browse files
committed
style(README): Add admonitions (note)
1 parent abd4dc1 commit 567cab3

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -565,9 +565,9 @@ where:
565565
- `.copy` shows the copy-to-clipboard button when present (hidden otherwise)
566566
- `title=“title of this code block”` adds a title to the code (none when absent)
567567
568-
Do note that:
569-
- There is a space before **and** after the opening curly brace ` { `.
570-
- There is space before the closing curly brace `}`.
568+
> [!NOTE]
569+
> - There is a space **before and after** the **opening** curly brace ` { `.
570+
> - There is space **before** the **closing** curly brace `}`.
571571
572572
573573
[Source](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/?h=copy+clipboard#code-copy-button)
@@ -615,7 +615,10 @@ The website uses the Markdown page of the glossary.
615615
### Add a Package
616616
617617
> [!NOTE]
618-
> In this section, the terms Python **package** and **dependency** refer to the same thing.
618+
> In this section:
619+
>
620+
> - the terms Python **package** and **dependency** refer to the same thing.
621+
> - `XXX` denotes the name of the package to add
619622
620623
- **Create** a feature **branch** (aka. topic branch)
621624
```shell

0 commit comments

Comments
 (0)