161 |
--------------------------------------------------------------------------------
/assets/catwalk.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/catppuccin/mdBook/666695ac488678b8fd1a15d73d0bd164d2d08a46/assets/catwalk.webp
--------------------------------------------------------------------------------
/assets/frappe.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/catppuccin/mdBook/666695ac488678b8fd1a15d73d0bd164d2d08a46/assets/frappe.webp
--------------------------------------------------------------------------------
/assets/latte.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/catppuccin/mdBook/666695ac488678b8fd1a15d73d0bd164d2d08a46/assets/latte.webp
--------------------------------------------------------------------------------
/assets/macchiato.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/catppuccin/mdBook/666695ac488678b8fd1a15d73d0bd164d2d08a46/assets/macchiato.webp
--------------------------------------------------------------------------------
/assets/mocha.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/catppuccin/mdBook/666695ac488678b8fd1a15d73d0bd164d2d08a46/assets/mocha.webp
--------------------------------------------------------------------------------
/example/.gitignore:
--------------------------------------------------------------------------------
1 | # mdbook build directory
2 | book
--------------------------------------------------------------------------------
/example/book.toml:
--------------------------------------------------------------------------------
1 | [book]
2 | authors = ["sgoudham"]
3 | language = "en"
4 | multilingual = false
5 | src = "src"
6 | title = "Catppuccin's mdBook"
7 |
8 | [preprocessor.admonish]
9 | command = "mdbook-admonish"
10 | assets_version = "3.0.3" # do not edit: managed by `mdbook-admonish install`
11 |
12 | [preprocessor.alerts]
13 |
14 | [output.html]
15 | default-theme = "latte"
16 | preferred-dark-theme = "mocha"
17 | additional-css = [
18 | "./theme/catppuccin.css",
19 | "./theme/catppuccin-admonish.css",
20 | "./theme/mdbook-admonish.css",
21 | "./theme/catppuccin-alerts.css",
22 | ]
23 | no-section-label = true
24 | git-repository-url = "https://github.com/catppuccin/mdBook"
25 | git-repository-icon = "fa-github"
26 | edit-url-template = "https://github.com/catppuccin/mdBook/edit/main/example/{path}"
27 | cname = "mdbook.catppuccin.com"
28 |
--------------------------------------------------------------------------------
/example/src/SUMMARY.md:
--------------------------------------------------------------------------------
1 | # Summary
2 |
3 | - [Landing](./landing.md)
4 | - [Admonishments](./admonish.md)
5 | - [Alerts](./alerts.md)
6 | - [Super Secret](./secret.md)
7 |
--------------------------------------------------------------------------------
/example/src/admonish.md:
--------------------------------------------------------------------------------
1 | # Reference
2 |
3 | The following admonishments are implemented by the
4 | [mdbook-admonish](https://github.com/tommilligan/mdbook-admonish) plugin and are
5 | automatically themed to match Catppuccin.
6 |
7 | ## Directives
8 |
9 | All supported directives are listed below.
10 |
11 | `note`
12 |
13 | ```admonish note
14 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
15 | ```
16 |
17 | `abstract`, `summary`, `tldr`
18 |
19 | ```admonish abstract
20 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
21 | ```
22 |
23 | `info`, `todo`
24 |
25 | ```admonish info
26 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
27 | ```
28 |
29 | `tip`, `hint`, `important`
30 |
31 | ```admonish tip
32 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
33 | ```
34 |
35 | `success`, `check`, `done`
36 |
37 | ```admonish success
38 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
39 | ```
40 |
41 | `question`, `help`, `faq`
42 |
43 | ```admonish question
44 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
45 | ```
46 |
47 | `warning`, `caution`, `attention`
48 |
49 | ```admonish warning
50 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
51 | ```
52 |
53 | `failure`, `fail`, `missing`
54 |
55 | ```admonish failure
56 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
57 | ```
58 |
59 | `danger`, `error`
60 |
61 | ```admonish danger
62 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
63 | ```
64 |
65 | `bug`
66 |
67 | ```admonish bug
68 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
69 | ```
70 |
71 | `example`
72 |
73 | ```admonish example
74 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
75 | ```
76 |
77 | `quote`, `cite`
78 |
79 | ```admonish quote
80 | Rust is a multi-paradigm, general-purpose programming language designed for performance and safety, especially safe concurrency.
81 | ```
82 |
--------------------------------------------------------------------------------
/example/src/alerts.md:
--------------------------------------------------------------------------------
1 | # Reference
2 |
3 | The following alerts are implemented by the
4 | [mdbook-alerts](https://github.com/lambdalisue/rs-mdbook-alerts) plugin and are
5 | automatically themed to match Catppuccin.
6 |
7 | ## Alerts
8 |
9 | All supported alerts are listed below.
10 |
11 | > [!NOTE]
12 | > Highlights information that users should take into account, even when skimming.
13 |
14 | > [!TIP]
15 | > Optional information to help a user be more successful.
16 |
17 | > [!IMPORTANT]
18 | > Crucial information necessary for users to succeed.
19 |
20 | > [!WARNING]
21 | > Critical content demanding immediate user attention due to potential risks.
22 |
23 | > [!CAUTION]
24 | > Negative potential consequences of an action.
25 |
--------------------------------------------------------------------------------
/example/src/landing.md:
--------------------------------------------------------------------------------
1 | # Example Markdown Document
2 |
3 | ## Information
4 |
5 | **crates.io**: [https://crates.io/crates/mdbook-catppuccin](https://crates.io/crates/mdbook-catppuccin)
6 |
7 | **repository**: [https://github.com/catppuccin/mdBook](https://github.com/catppuccin/mdBook)
8 |
9 | ## Text
10 |
11 | Here is a paragraph with bold text. **This is some bold text.** Here is a
12 | paragraph with bold text. **This is also some bold text.**
13 |
14 | Here is another one with italic text. _This is some italic text._ Here is
15 | another one with italic text. _This is some italic text._
16 |
17 | Here is another one with struckout text. ~~This is some struckout text.~~
18 |
19 |
20 | This is some text in a warning block.
21 |
22 | Warning blocks should be used sparingly in documentation, to avoid "warning
23 | fatigue," where people are trained to ignore them because they usually don't
24 | matter for what they're doing.
25 |
26 |
27 | ## Links
28 |
29 | Autolink:
30 |
31 | Link: [Example](http://example.com)
32 |
33 | Reference style [link][1].
34 |
35 | [1]: http://example.com "Example"
36 |
37 | ## Images
38 |
39 |
40 |
41 | ## Headers
42 |
43 | # First level title
44 |
45 | ## Second level title
46 |
47 | ### Third level title
48 |
49 | #### Fourth level title
50 |
51 | ##### Fifth level title
52 |
53 | ###### Sixth level title
54 |
55 | ### Title with [link](http://localhost)
56 |
57 | ### Title with 
58 |
59 | ## Code
60 |
61 | Inline `code span in a` paragraph.
62 |
63 | ```
64 | This
65 | is
66 | code
67 | fence
68 | ```
69 |
70 | ```java
71 | public class Main {
72 | public static void main(String[] args) {
73 | System.out.println("Hello, World!");
74 | System.out.println("This is some Java code!");
75 | }
76 | }
77 | ```
78 |
79 | This is a code block:
80 |
81 | /**
82 | * Sorts the specified array into ascending numerical order.
83 | *
84 | *
Implementation note: The sorting algorithm is a Dual-Pivot Quicksort
85 | * by Vladimir Yaroslavskiy, Jon Bentley, and Joshua Bloch. This algorithm
86 | * offers O(n log(n)) performance on many data sets that cause other
87 | * quicksorts to degrade to quadratic performance, and is typically
88 | * faster than traditional (one-pivot) Quicksort implementations.
89 | *
90 | * @param a the array to be sorted
91 | */
92 | public static void sort(byte[] a) {
93 | DualPivotQuicksort.sort(a);
94 | }
95 |
96 | ## Quotes
97 |
98 | > This is the first level of quoting.
99 | >
100 | > > This is nested blockquote.
101 | >
102 | > Back to the first level.
103 |
104 | > A list within a blockquote:
105 | >
106 | > - asterisk 1
107 | > - asterisk 2
108 | > - asterisk 3
109 |
110 | > Formatting within a blockquote:
111 | >
112 | > ### header
113 | >
114 | > Link: [Example](http://example.com)
115 |
116 | ## Html
117 |
118 | This is inline html
4 | Catppuccin for mdBook
5 | 
17 | 
24 | 
28 | 
32 | 
36 | 
152 | 
160 | 
40 |
41 | ## Headers
42 |
43 | # First level title
44 |
45 | ## Second level title
46 |
47 | ### Third level title
48 |
49 | #### Fourth level title
50 |
51 | ##### Fifth level title
52 |
53 | ###### Sixth level title
54 |
55 | ### Title with [link](http://localhost)
56 |
57 | ### Title with 
58 |
59 | ## Code
60 |
61 | Inline `code span in a` paragraph.
62 |
63 | ```
64 | This
65 | is
66 | code
67 | fence
68 | ```
69 |
70 | ```java
71 | public class Main {
72 | public static void main(String[] args) {
73 | System.out.println("Hello, World!");
74 | System.out.println("This is some Java code!");
75 | }
76 | }
77 | ```
78 |
79 | This is a code block:
80 |
81 | /**
82 | * Sorts the specified array into ascending numerical order.
83 | *
84 | *