-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #394 from vordgi/rd-392
rd-392 support github styled blockquotes
- Loading branch information
Showing
5 changed files
with
59 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Blockquotes | ||
|
||
`blockquote` is a standard markdown element that allows you to highlight text or quote information | ||
|
||
```md | ||
> Basic information that is additional or related to the main text. | ||
``` | ||
|
||
> Basic information that is additional or related to the main text. | ||
Robindoc additionally supports the [GitHub alerts format](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts). This way you can highlight important information more clearly. | ||
|
||
```md | ||
> [!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] | ||
> 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Build-in blocks | ||
|
||
Robindoc provides several built-in extensions for markdown. | ||
|
||
Since the framework is focused specifically on markdown. This makes it possible to maintain the same style for all platforms. The user can quickly view the original files, and then use the full documentation site. And in both cases he will receive all the necessary information. | ||
|
||
However, in all non-standard situations you can [use JSX](../01-getting-started/02-writing-md.md). | ||
|
||
## Current extensions | ||
|
||
- [Blockquotes](./01-blockquotes.md) | ||
|
||
- _Documentation under development_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters