Example Markdown Document
Information
crates.io: https://crates.io/crates/mdbook-catppuccin
repository: https://github.com/catppuccin/mdBook
Text
Here is a paragraph with bold text. This is some bold text. Here is a paragraph with bold text. This is also some bold text.
Here is another one with italic text. This is some italic text. Here is another one with italic text. This is some italic text.
Here is another one with struckout text. This is some struckout text.
Warning blocks should be used sparingly in documentation, to avoid "warning fatigue," where people are trained to ignore them because they usually don't matter for what they're doing.
Links
Autolink: http://example.com
Link: Example
Reference style link.
Images
Headers
First level title
Second level title
Third level title
Fourth level title
Fifth level title
Sixth level title
Title with link
Title with 
Code
Inline code span in a
paragraph.
This
is
code
fence
public class Main {
public static void main(String[] args) {
System.out.println("Hello, World!");
System.out.println("This is some Java code!");
}
}
This is a code block:
/**
* Sorts the specified array into ascending numerical order.
*
* <p>Implementation note: The sorting algorithm is a Dual-Pivot Quicksort
* by Vladimir Yaroslavskiy, Jon Bentley, and Joshua Bloch. This algorithm
* offers O(n log(n)) performance on many data sets that cause other
* quicksorts to degrade to quadratic performance, and is typically
* faster than traditional (one-pivot) Quicksort implementations.
*
* @param a the array to be sorted
*/
public static void sort(byte[] a) {
DualPivotQuicksort.sort(a);
}
Quotes
This is the first level of quoting.
This is nested blockquote.
Back to the first level.
A list within a blockquote:
- asterisk 1
- asterisk 2
- asterisk 3
Formatting within a blockquote:
header
Link: Example
Html
This is inline html. And this is an html block.
Column 1 | Column 2 |
---|---|
Row 1 Cell 1 | Row 1 Cell 2 |
Row 2 Cell 1 | Row 2 Cell 2 |
Horizontal rules
Lists
Unordered list:
- asterisk 1
- asterisk 2
- asterisk 3
Ordered list:
- First
- Second
- Third
Mixed:
- First
- Second:
- Fee
- Fie
- Foe
- Third
Definition list:
Some term : First definition : Second definition
Tables:
Header 1 | Header 2 |
---|---|
Data 1 | Data 2 |
Reference
The following admonishments are implemented by the mdbook-admonish plugin and are automatically themed to match Catppuccin.
Directives
All supported directives are listed below.
note
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
abstract
, summary
, tldr
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
info
, todo
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
tip
, hint
, important
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
success
, check
, done
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
question
, help
, faq
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
warning
, caution
, attention
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
failure
, fail
, missing
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
danger
, error
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
bug
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
example
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
quote
, cite
Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
Reference
The following alerts are implemented by the mdbook-alerts plugin and are automatically themed to match Catppuccin.
Alerts
All supported alerts are listed below.
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.
Super Secret
You thought you'd find something here, didn't you?
Here, have a cookie for your efforts: 🍪