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>"}.
::github{repo="iyanarmanda/fumika"}Admonitions
Following types of admonitions are supported: note tip important warning caution
NOTEHighlights information that users should take into account, even when skimming.
TIPOptional information to help a user be more successful.
IMPORTANTCrucial information necessary for users to succeed.
WARNINGCritical content demanding immediate user attention due to potential risks.
CAUTIONNegative potential consequences of an action.
Basic Syntax
:::noteHighlights information that users should take into account, even when skimming.:::
:::tipOptional information to help a user be more successful.:::Custom Titles
The title of the admonition can be customized.
MY CUSTOM TITLEThis is a note with a custom title.
:::note[MY CUSTOM TITLE]This is a note with a custom title.:::GitHub Syntax
TIPThe GitHub syntax is also supported.
> [!NOTE]> The GitHub syntax is also supported.
> [!TIP]> The GitHub syntax is also supported.Spoiler
You can add spoilers to your text. The text also supports Markdown syntax.
The content
The content :spoiler[is hidden **ayyy**]!Typography Features
WARNINGThese feature below not supported in Frontmatter Post and TOC
Ruby Text
Add small characters above the text. For example:
- Welcome to Tokyo!
- 漢字 are Japanese characters.
- He is a rookie in this baseball team.
Welcome to {Tokyo}^(とうきょう)!
{[漢][字]}^([かん][じ]) are Japanese characters.
He is a {rookie}^(beginner) in this baseball team.Text Direction
Controlling text direction (RTL/LTR) within your content.
Inline Usage:
This is an English sentence containing an inline Persian phrase: سلام دنیا in the middle of a text.
این یک متن فارسی است که یک عبارت انگلیسی Hello World در وسط آن قرار دارد
This is an English sentence containing an inline Persian phrase: :rtl[سلام دنیا] in the middle of a text.
این یک متن فارسی است که یک عبارت انگلیسی :ltr[Hello World] در وسط آن قرار داردSingle-Line Block Usage:
::rtl[این یک خط متن کامل به زبان فارسی است.]
::ltr[This is a full single-line sentence explicitly rendered as LTR.]Container Block Usage:
عنوان فارسی
این یک بلوک کامل شامل چند پاراگراف به زبان فارسی است.
- آیتم اول
- آیتم دوم
English Sub-section
This whole block is explicitly forced to be LTR inside an RTL document.
:::rtl**عنوان فارسی**
این یک بلوک کامل شامل چند پاراگراف به زبان فارسی است.
- آیتم اول- آیتم دوم:::
:::ltr**English Sub-section**
This whole block is explicitly forced to be LTR inside an RTL document.:::