mirror of
https://github.com/reonokiy/blog.nokiy.net.git
synced 2025-06-16 03:32:51 +02:00
84 lines
1.6 KiB
Text
84 lines
1.6 KiB
Text
---
|
|
title: Markdown Style Guide
|
|
published: 2025-03-08
|
|
updated: 2025-03-12
|
|
tags: ["Guide"]
|
|
pin: 1
|
|
lang: en
|
|
---
|
|
|
|
FROM https://github.com/saicaca/fuwari
|
|
|
|
## GitHub Repository Cards
|
|
You can add dynamic cards that link to GitHub repositories, on page load, the repository information is pulled from the GitHub API.
|
|
|
|
::github{repo="Fabrizz/MMM-OnSpotify"}
|
|
|
|
Create a GitHub repository card with the code `::github{repo="<owner>/<repo>"}`.
|
|
|
|
```markdown
|
|
::github{repo="saicaca/fuwari"}
|
|
```
|
|
|
|
## Admonitions
|
|
|
|
Following types of admonitions are supported: `note` `tip` `important` `warning` `caution`
|
|
|
|
:::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.
|
|
:::
|
|
|
|
### Basic Syntax
|
|
|
|
```markdown
|
|
:::note
|
|
Highlights information that users should take into account, even when skimming.
|
|
:::
|
|
|
|
:::tip
|
|
Optional information to help a user be more successful.
|
|
:::
|
|
```
|
|
|
|
### Custom Titles
|
|
|
|
The title of the admonition can be customized.
|
|
|
|
:::note[MY CUSTOM TITLE]
|
|
This is a note with a custom title.
|
|
:::
|
|
|
|
```markdown
|
|
:::note[MY CUSTOM TITLE]
|
|
This is a note with a custom title.
|
|
:::
|
|
```
|
|
|
|
### GitHub Syntax
|
|
|
|
> [!TIP]
|
|
> [The GitHub syntax](https://github.com/orgs/community/discussions/16925) is also supported.
|
|
|
|
```
|
|
> [!NOTE]
|
|
> The GitHub syntax is also supported.
|
|
|
|
> [!TIP]
|
|
> The GitHub syntax is also supported.
|
|
```
|