Skip to content

Commit 4cacacf

Browse files
committed
Use alert syntax for warnings
Github supports alert extensions which are rendered much nicer. Examples: > [!NOTE] > Highlights information that users should take into account, even when skimming. > [!TIP] > Optional information to help a user be more successful. > [!IMPORTANT] > Crucial information necessary for users to succeed. > [!WARNING] > Critical content demanding immediate user attention due to potential risks. > [!CAUTION] > Negative potential consequences of an action. [1] https://github.com/orgs/community/discussions/16925 Signed-off-by: Nir Soffer <[email protected]>
1 parent c014464 commit 4cacacf

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,7 @@ mkdir -p ${HOMEBREW_PREFIX}/var/run
6161
sudo ${HOMEBREW_PREFIX}/opt/socket_vmnet/bin/socket_vmnet --vmnet-gateway=192.168.105.1 ${HOMEBREW_PREFIX}/var/run/socket_vmnet
6262
```
6363

64-
> **Warning**
65-
>
64+
> [!WARNING]
6665
> Typically, the `socket_vmnet` binary in the `${HOMEBREW_PREFIX}` can be replaced by any user in the `admin` group.
6766
6867
<details>

0 commit comments

Comments
 (0)