Skip to content

Commit b51d60f

Browse files
committed
🐭 Docs: Fix admonition syntax and typo
Three `!!!note` admonitions in `dev-standards.md` were missing the required space before the type keyword, causing MkDocs to render them as plain text instead of styled callouts. Also fix a "the" → "then" typo in `developer.md`.
1 parent 4a5d8be commit b51d60f

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/dev-standards.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Good development standards make for better code.
55

66
**Versioning**: We try to adhere to [SemVer](https://semver.org/).
77

8-
!!!note
8+
!!! note
99

1010
The stipulations below are based on experience, but are still evolving.
1111
This text is mainly here to provide a starting point for discussion with collaborators.
@@ -103,14 +103,14 @@ Similarly, if a dependency is changed, it's convenient to quickly spot this, e.g
103103
| 🐭 | minor changes (typos etc.; exclude from changelog) | `chore` | No |
104104
|| anything not covered above (last resort) | `chore` | No |
105105

106-
!!!note
106+
!!! note
107107

108108
We are aware of other standards like [GitMoji](https://gitmoji.dev/), but limit the number in order to avoid choice overload.
109109
Too many options make it difficult for contributors to know all of them, makes changelogs too fragmented and leads to decision paralysis.
110110
Moreover, we avoid emojis that typically have width issues in some terminals.
111111
<!-- TODO: Also look into and add reference to https://github.com/ahmadawais/Emoji-Log -->
112112

113-
!!!note
113+
!!! note
114114

115115
Not everyone likes emojis. In the dropdown below you can find some common concerns.
116116

docs/developer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ And then push the tag to the remote, here named `origin`:
5151

5252
git push origin --tags
5353

54-
You can the go to the [Github releases](https://github.com/mbercx/python-copier/releases) and make a new release based on the new tag.
54+
You can then go to the [Github releases](https://github.com/mbercx/python-copier/releases) and make a new release based on the new tag.

0 commit comments

Comments
 (0)