mirror of
https://github.com/reonokiy/blog.nokiy.net.git
synced 2025-06-17 03:56:19 +02:00
docs: add multi-language markdown-extended-features post
This commit is contained in:
parent
6c8a682f83
commit
bdaf3da70c
7 changed files with 438 additions and 16 deletions
85
src/content/posts/guides/Markdown Extended Features-en.md
Normal file
85
src/content/posts/guides/Markdown Extended Features-en.md
Normal file
|
@ -0,0 +1,85 @@
|
|||
---
|
||||
title: Markdown Extended Features
|
||||
published: 2025-04-25
|
||||
tags:
|
||||
- Guide
|
||||
toc: false
|
||||
lang: en
|
||||
abbrlink: markdown-extended-features
|
||||
---
|
||||
|
||||
Here are some extended Markdown features supported by Retypeset, including syntax examples and their stylistic effects.
|
||||
|
||||
## Figure Captions
|
||||
|
||||
To create automatic figure captions, use the standard Markdown image syntax ``. To hide the caption, add an underscore `_` before the `alt` text or leave the `alt` text empty.
|
||||
|
||||
### Syntax
|
||||
|
||||
```
|
||||

|
||||
|
||||

|
||||
```
|
||||
|
||||
### Output
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## Github Repository Cards
|
||||
|
||||
To create a Github repository card, use the double colon syntax `::github{repo="owner/repo"}`. Repository data is fetched from the GitHub API after the page loads.
|
||||
|
||||
### Syntax
|
||||
|
||||
```
|
||||
::github{repo="radishzzz/astro-theme-retypeset"}
|
||||
```
|
||||
|
||||
### Output
|
||||
|
||||
::github{repo="radishzzz/astro-theme-retypeset"}
|
||||
|
||||
## Admonition Blocks
|
||||
|
||||
To create admonition blocks, use the GitHub syntax `> [!TYPE]` or the triple colon syntax `:::type`. Following types are supported: `note`, `tip`, `important`, `warning`, and `caution`.
|
||||
|
||||
### Syntax
|
||||
|
||||
```
|
||||
> [!NOTE]
|
||||
> Useful information that users should know, even when skimming content.
|
||||
|
||||
:::note
|
||||
Useful information that users should know, even when skimming content.
|
||||
:::
|
||||
|
||||
:::note[YOUR CUSTOM TITLE]
|
||||
This is a note with a custom title.
|
||||
:::
|
||||
```
|
||||
|
||||
### Output
|
||||
|
||||
> [!NOTE]
|
||||
> Useful information that users should know, even when skimming content.
|
||||
|
||||
> [!TIP]
|
||||
> Helpful advice for doing things better or more easily.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Key information users need to know to achieve their goal.
|
||||
|
||||
:::warning
|
||||
Urgent info that needs immediate user attention to avoid problems.
|
||||
:::
|
||||
|
||||
:::caution
|
||||
Advises about risks or negative outcomes of certain actions.
|
||||
:::
|
||||
|
||||
:::note[YOUR CUSTOM TITLE]
|
||||
This is a note with a custom title.
|
||||
:::
|
Loading…
Add table
Add a link
Reference in a new issue