Skip to content

Commit

Permalink
feat: add example mdBook
Browse files Browse the repository at this point in the history
closes #3
  • Loading branch information
sgoudham committed Jun 15, 2023
1 parent 0a71e93 commit 3469e9e
Show file tree
Hide file tree
Showing 8 changed files with 1,230 additions and 0 deletions.
2 changes: 2 additions & 0 deletions example/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# mdbook build directory
book
21 changes: 21 additions & 0 deletions example/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[book]
authors = ["sgoudham"]
language = "en"
multilingual = false
src = "src"
title = "Catppuccin's mdBook"

[preprocessor]

[preprocessor.catppuccin]
assets_version = "0.2.0" # DO NOT EDIT: Managed by `mdbook-catppuccin install`

[output.html]
default-theme = "mocha"
preferred-dark-theme = "mocha"
additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-highlight.css"]
no-section-label = true
git-repository-url = "https://github.com/catppuccin/mdBook"
git-repository-icon = "fa-github"
edit-url-template = "https://github.com/catppuccin/mdBook/edit/main/{path}"
cname = "mdbook.catppuccin.com"
4 changes: 4 additions & 0 deletions example/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Summary

- [Landing](./first.md)
- [Super Secret](./secret.md)
179 changes: 179 additions & 0 deletions example/src/first.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
# Example Markdown Document

## Information

**crates.io**: [https://crates.io/crates/mdbook-catppuccin](https://crates.io/crates/mdbook-catppuccin)

**repository**: [https://github.com/catppuccin/mdBook](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.~~

## Links

Autolink: <http://example.com>

Link: [Example](http://example.com)

Reference style [link][1].

[1]: http://example.com "Example"

## Images

<img src="https://avatars.githubusercontent.com/u/58985301" width="150">

## Headers

# First level title

## Second level title

### Third level title

#### Fourth level title

##### Fifth level title

###### Sixth level title

### Title with [link](http://localhost)

### Title with ![image](http://localhost)

## Code

Inline `code span in a` paragraph.

```
This
is
code
fence
```

```java
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](http://example.com)
## Html

This is inline <span>html</html>.
And this is an html block.

<table>
<tr>
<th>Column 1</th>
<th>Column 2</th>
</tr>
<tr>
<td>Row 1 Cell 1</td>
<td>Row 1 Cell 2</td>
</tr>
<tr>
<td>Row 2 Cell 1</td>
<td>Row 2 Cell 2</td>
</tr>
</table>

## Horizontal rules

---

---

---

## Lists

Unordered list:

- asterisk 1
- asterisk 2
- asterisk 3

Ordered list:

1. First
2. Second
3. Third

Mixed:

1. First
2. Second:

- Fee
- Fie
- Foe

3. Third

Definition list:

Some term
: First definition
: Second definition

Tables:

| Header 1 | Header 2 |
| -------- | -------- |
| Data 1 | Data 2 |

## Admonishments (NOT SUPPORTED YET - [#2](https://github.com/catppuccin/mdBook/issues/2))

> **Note**:
> This is a note!
> **Warning**:
> This is a warning!
5 changes: 5 additions & 0 deletions example/src/secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Super Secret

You thought you'd find something here didn't you?

Here, have a cookie for your efforts: 🍪

0 comments on commit 3469e9e

Please sign in to comment.