-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add mdbook-admonish support (#59)
Co-authored-by: sgoudham <sgoudham@gmail.com>
- Loading branch information
1 parent
c5dca94
commit c8ba6ec
Showing
10 changed files
with
1,107 additions
and
230 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 |
---|---|---|
@@ -1,4 +1,5 @@ | ||
# Summary | ||
|
||
- [Landing](./first.md) | ||
- [Landing](./landing.md) | ||
- [Admonishments](./admonish.md) | ||
- [Super Secret](./secret.md) |
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,81 @@ | ||
# Reference | ||
|
||
The following admonishments are implemented by the | ||
[`mdbook-admonish`](https://github.com/tommilligan/mdbook-admonish) plugin and | ||
are automatically themed to match Catppuccin. | ||
|
||
## Directives | ||
|
||
All supported directives are listed below. | ||
|
||
`note` | ||
|
||
```admonish note | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`abstract`, `summary`, `tldr` | ||
|
||
```admonish abstract | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`info`, `todo` | ||
|
||
```admonish info | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`tip`, `hint`, `important` | ||
|
||
```admonish tip | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`success`, `check`, `done` | ||
|
||
```admonish success | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`question`, `help`, `faq` | ||
|
||
```admonish question | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`warning`, `caution`, `attention` | ||
|
||
```admonish warning | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`failure`, `fail`, `missing` | ||
|
||
```admonish failure | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`danger`, `error` | ||
|
||
```admonish danger | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`bug` | ||
|
||
```admonish bug | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`example` | ||
|
||
```admonish example | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` | ||
|
||
`quote`, `cite` | ||
|
||
```admonish quote | ||
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency. | ||
``` |
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 |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# Super Secret | ||
|
||
You thought you'd find something here didn't you? | ||
You thought you'd find something here, didn't you? | ||
|
||
Here, have a cookie for your efforts: 🍪 | ||
Here, have a cookie for your efforts: 🍪 |
Oops, something went wrong.