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.

Create a GitHub repository card with the code ::github{repo="<owner>/<repo>"}.

1
::github{repo="saicaca/fuwari"}

GitHub File Cards#

You can add dynamic cards that link to a specific file in a GitHub repository, on page load, the file metadata is pulled from the GitHub API.

Create a GitHub file card with the code ::githubfile{repo="<owner>/<repo>" file="path/to/file.ext"}.

Optional parameters: description (string) and path (alias for file).

1
::githubfile{repo="saicaca/fuwari" file="README.md" description="Theme overview"}

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.

1
:::note
2
Highlights information that users should take into account, even when skimming.
3
:::
4

5
:::tip
6
Optional information to help a user be more successful.
7
:::

1
:::note[MY CUSTOM TITLE]
2
This is a note with a custom title.
3
:::

1
> [!NOTE]
2
> The GitHub syntax is also supported.
3

4
> [!TIP]
5
> The GitHub syntax is also supported.

PlantUML#

PlantUML diagrams can be written as fenced code blocks and rendered through the configured PlantUML server.

1
The content :spoiler[is hidden **ayyy**]!