Skip to content

Commit 441a2c1

Browse files
committed
switch to zola
1 parent 4ec510c commit 441a2c1

38 files changed

Lines changed: 260 additions & 15007 deletions

.github/workflows/deploy.yml

Lines changed: 27 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,37 @@
1-
name: Deploy
1+
name: Build and deploy Zola website
22
on:
33
push:
44
branches:
5-
- main
5+
- master
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: "pages"
14+
cancel-in-progress: true
615

716
jobs:
8-
deploy:
17+
build:
918
runs-on: ubuntu-latest
10-
permissions:
11-
contents: write # To push a branch
12-
pages: write # To push to a GitHub Pages site
13-
id-token: write # To update the deployment status
1419
steps:
15-
- uses: actions/checkout@v4
16-
with:
17-
fetch-depth: 0
18-
- uses: pnpm/action-setup@v4
19-
with:
20-
version: 10
21-
- name: Setup Node.js
22-
uses: actions/setup-node@v4
23-
with:
24-
node-version: '20'
25-
cache: pnpm
26-
- name: Install npm dependencies
27-
run: pnpm install
28-
- name: Setup Python
29-
uses: actions/setup-python@v5
30-
with:
31-
python-version: '3.x'
32-
- name: Install Python dependencies
33-
run: |
34-
python -m pip install --upgrade pip
35-
pip install markdown
36-
- name: Build tooltips
37-
run: pnpm run postinstall
38-
- name: Install mdbook
39-
uses: taiki-e/install-action@v2
40-
with:
41-
tool: mdbook@0.4.52
42-
- name: Install mdbook-admonish
43-
uses: taiki-e/install-action@v2
44-
with:
45-
tool: mdbook-admonish
46-
- name: Run mdbook-admonish install
47-
run: |
48-
mdbook-admonish install
49-
- name: Install mdbook-alerts
50-
uses: taiki-e/install-action@v2
51-
with:
52-
tool: mdbook-alerts
53-
- name: Install mdbook-embedify
54-
uses: taiki-e/install-action@v2
55-
with:
56-
tool: mdbook-embedify
57-
- name: Install mdbook-github-authors
58-
uses: taiki-e/install-action@v2
59-
with:
60-
tool: mdbook-github-authors
61-
- name: Build Book
62-
run: |
63-
# This assumes your book is in the root of your repository.
64-
# Just add a `cd` here if you need to change to another directory.
65-
mdbook build
66-
- name: Setup Pages
67-
uses: actions/configure-pages@v4
68-
- name: Upload artifact
69-
uses: actions/upload-pages-artifact@v3
20+
- name: checkout
21+
uses: actions/checkout@v6.0.1
22+
23+
- name: Build Zola + upload Pages artifact
24+
uses: getzola/github-pages@066755243e69f508fd1a74739fbf1a65f656c790
7025
with:
71-
# Upload entire repository
72-
path: "book"
26+
zola_version: v0.22.0
27+
28+
deploy:
29+
runs-on: ubuntu-latest
30+
needs: build
31+
environment:
32+
name: github-pages
33+
url: ${{ steps.deployment.outputs.page_url }}
34+
steps:
7335
- name: Deploy to GitHub Pages
7436
id: deployment
75-
uses: actions/deploy-pages@v4
37+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

book.toml

Lines changed: 0 additions & 32 deletions
This file was deleted.

content/_index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
+++
2+
insert_anchor_links = "left"
3+
title = "Home"
4+
+++
5+
6+
{% crt() %}
7+
```
8+
╔═══════════════════════════════════════════════╗
9+
║ ╔═══╗ ╔═══╗ ╔═══╗ ╔═══╗ ╔═══╗ ╔═══╗ ╔═══╗ ║
10+
║ ║ B ║ ║ O ║ ║ O ║ ║ K ║ ║ ║ ║ S ║ ║ H ║ ║
11+
║ ║ ║ ║ ║ ║ ║ ║ ║ ║ ║ ║ ║ ║ ║ ║
12+
║ ╚═══╝ ╚═══╝ ╚═══╝ ╚═══╝ ╚═══╝ ╚═══╝ ╚═══╝ ║
13+
╠═══════════════════════════════════════════════╣
14+
║ ┌─────┐ ┌─────┐ ┌─────┐ ┌─────┐ ┌─────┐ ║
15+
║ │░░░░░│ │░░░░░│ │░░░░░│ │░░░░░│ │░░░░░│ ║
16+
║ │░░░░░│ │░░░░░│ │░░░░░│ │░░░░░│ │░░░░░│ ║
17+
║ └─────┘ └─────┘ └─────┘ └─────┘ └─────┘ ║
18+
╠═══════════════════════════════════════════════╣
19+
║ ┏━━━━━┓ ┏━━━━━┓ ┏━━━━━┓ ┏━━━━━┓ ┏━━━━━┓ ║
20+
║ ┃░░░░░┃ ┃░░░░░┃ ┃░░░░░┃ ┃░░░░░┃ ┃░░░░░┃ ║
21+
║ ┃░░░░░┃ ┃░░░░░┃ ┃░░░░░┃ ┃░░░░░┃ ┃░░░░░┃ ║
22+
║ ┗━━━━━┛ ┗━━━━━┛ ┗━━━━━┛ ┗━━━━━┛ ┗━━━━━┛ ║
23+
╠═══════════════════════════════════════════════╣
24+
║ ╭─────╮ ╭─────╮ ╭─────╮ ╭─────╮ ╭─────╮ ║
25+
║ │░░░░░│ │░░░░░│ │░░░░░│ │░░░░░│ │░░░░░│ ║
26+
║ │░░░░░│ │░░░░░│ │░░░░░│ │░░░░░│ │░░░░░│ ║
27+
║ ╰─────╯ ╰─────╯ ╰─────╯ ╰─────╯ ╰─────╯ ║
28+
╚═══════════════════════════════════════════════╝
29+
```
30+
{% end %}
31+
32+
# Homepage
33+
Welcome to the note book to end note books

content/chest-shop.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
+++
2+
insert_anchor_links = "left"
3+
title = "Creating a Player Shop with ChestShop"
4+
[extra]
5+
go_to_top = true
6+
+++
7+
8+
Creating your own shop using the ChestShop plugin is straightforward. Follow these steps:
9+
10+
1. **Place a Chest:** Begin by placing a chest on the ground where you want your shop to be.
11+
2. **Place a Sign:** Place a sign one block away from the chest. A common position is directly above the chest.
12+
3. **Write on the Sign:** Interact with the sign to write the shop details. The format for the sign is crucial:
13+
14+
<figure>
15+
{{ image(url="/chest-shop.gif", alt="Example Sign", no_hover=true) }}
16+
<figcaption>Example Sign</figcaption>
17+
</figure>
18+
19+
Here's what each line means:
20+
21+
* **Line 1:** Leave this line empty. The plugin will automatically fill it with your in-game name.
22+
* **Line 2:** Enter the amount of items you want to buy or sell in a single transaction.
23+
* **Line 3:** Specify the prices for buying and/or selling. This line uses a combination of price indicators and values.
24+
* `B` indicates the price at which *players* can *buy* items from your shop.
25+
* `S` indicates the price at which *players* can *sell* items to your shop.
26+
* Prices are separated by a colon (`:`).
27+
* Examples of valid price combinations:
28+
* `B 5: S 5`: Players can buy for 5, and sell for 5.
29+
* `B 5`: Players can only buy for 5.
30+
* `S free`: Players can sell to your shop for free.
31+
* **Line 4:** Specify the item being traded. You can write `?` on the sign, and the plugin will automatically detect the item from the chest when you're done writing the sign or after you click the sign with the item in your hand. Alternatively, you can write the item's name or ID directly.
32+
33+
> [!TIP]
34+
> You can find the name of the item you are trying to sell by going to the [Minecraft Wiki](https://minecraft.wiki).
35+
36+
4. **Complete the Shop:** Once the sign is correctly filled out and placed next to the chest, your shop is ready!
37+
38+
<details>
39+
<summary>Resulting Shop</summary>
40+
{{ image(url="/done-shop.gif", alt="Completed Shop", no_hover=true) }}
41+
</details>
42+
43+
## Video Guide:
44+
45+
{{ youtube(id="Zap3snBb5Fw", start="625") }}
Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Docker
1+
+++
2+
insert_anchor_links = "left"
3+
title = "Docker"
4+
[extra]
5+
go_to_top = true
6+
+++
27

38
Docker is a platform used for developing, shipping, and running applications in containers. Installing it can sometimes involve several steps, and if you're setting up multiple machines or doing it frequently, remembering the exact process can be tedious.
49

@@ -14,34 +19,33 @@ This note serves as a quick reference for installing Docker using the convenienc
1419
```sh
1520
sudo sh install-docker.sh
1621
```
17-
18-
```admonish info
22+
{% alert(important=true) %}
1923
This executes the downloaded script with superuser privileges to perform the installation.
20-
```
24+
{% end %}
2125
3. **Add your user to the `docker` group:**
2226
```sh
2327
sudo usermod -aG docker (username)
2428
```
2529

26-
```admonish warning
30+
{% alert(warning=true) %}
2731
Replace `(username)` with your actual username. This command adds your current user to the `docker` group. Membership in this group allows you to run Docker commands without needing `sudo`. While convenient, understand that members of the `docker` group have permissions equivalent to the root user regarding Docker, so exercise caution.
28-
```
32+
{% end %}
2933

3034
4. **Reboot your system:**
3135
```sh
3236
sudo reboot
3337
```
3438

35-
```admonish tip
39+
{% alert(tip=true) %}
3640
A reboot is usually required for the group changes made in the previous step to take effect.
37-
```
41+
{% end %}
3842

3943
5. **Verify the installation:**
4044
After your system has restarted and you've logged back in, you can verify that Docker is installed and you can run commands without `sudo` by running the `hello-world` container:
4145
```sh
4246
docker run hello-world
4347
```
4448
45-
```admonish info
49+
{% alert(note=true) %}
4650
This command downloads a test image and runs it in a container. If everything is set up correctly, you should see a message confirming that your Docker installation is working.
47-
```
51+
{% end %}

src/gui.md renamed to content/linux/gui.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# Managing the Graphical User Interface (GUI)
1+
+++
2+
insert_anchor_links = "left"
3+
title = "Managing the Graphical User Interface (GUI)"
4+
[extra]
5+
go_to_top = true
6+
+++
27

38
This document provides commands to switch your system's default boot target between the graphical user interface (GUI) mode and the command-line interface (CLI) mode.
49

510
Switching between these modes can be useful depending on whether you need a graphical environment or prefer working solely from the command line.
611

7-
```admonish note
8-
These commands are applicable for systems using `systemd`.
9-
```
12+
> [!NOTE]
13+
> These commands are applicable for systems using `systemd`.
1014
1115
## Disable GUI (Boot to Command Line):
1216

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
# Some helpful command line programs
1+
+++
2+
insert_anchor_links = "left"
3+
title = "Some helpful command line programs"
4+
[extra]
5+
go_to_top = true
6+
+++
27

38
This page lists some command-line tools that can significantly enhance your productivity and make working in the terminal easier and more efficient.
49

5-
## Tmux :simple-icons-tmux:
10+
## Tmux:
611

7-
Tmux (Terminal Multiplexer)[^tooltip:A tool that lets you switch between several programs in one terminal, detach them, and reattach them later.] allows you to create and control multiple terminal sessions within a single window.
12+
Tmux (Terminal Multiplexer)[^tmux] allows you to create and control multiple terminal sessions within a single window.
813

914
Can be installed by running:
1015

@@ -22,10 +27,9 @@ To start a new Tmux session:
2227
tmux
2328
```
2429

25-
```admonish tip
26-
To detach from a session (leaving it running in the background):
27-
Press `Ctrl+b` followed by `d`.
28-
```
30+
> [!TIP]
31+
> To detach from a session (leaving it running in the background):
32+
> Press `Ctrl+b` followed by `d`.
2933
3034
To list existing sessions:
3135

@@ -45,13 +49,12 @@ To reattach to a specific session (replace `0` with the session number):
4549
tmux attach -t 0
4650
```
4751

48-
## TLDR :simple-icons-tldraw:
52+
## TLDR:
4953

50-
```admonish info
51-
Shows simplified examples for command-line tools.
52-
```
54+
>[!NOTE]
55+
> Shows simplified examples for command-line tools.
5356
54-
TLDR provides simplified, community-maintained examples for command-line programs. It cuts through lengthy man pages to give you just the common use cases.[^tooltip:@tldr-versions]
57+
TLDR provides simplified, community-maintained examples for command-line programs. It cuts through lengthy man pages to give you just the common use cases.
5558

5659
**Basic Usage:**
5760

@@ -67,9 +70,9 @@ To see examples for the `ls` command with macOS options:
6770
tldr ls --platform osx
6871
```
6972

70-
## htop :simple-icons-htop:
73+
## htop:
7174

72-
htop is an interactive process viewer for Unix-like systems. It provides a dynamic real-time view of processes running on the system, showing CPU usage, memory usage, swap usage, and tasks.[^tooltip:It's an improved version of the standard `top` command with a more user-friendly interface.]
75+
htop is an interactive process viewer for Unix-like systems. It provides a dynamic real-time view of processes running on the system, showing CPU usage, memory usage, swap usage, and tasks.[^htop]
7376

7477
Can be installed by running:
7578

@@ -85,6 +88,8 @@ Simply run `htop` to launch the interactive viewer:
8588
htop
8689
```
8790

88-
```admonish tip
89-
Inside `htop`, you can use arrow keys to navigate and function keys (like F1 for Help, F3 for Search, F9 for Kill, F10 to Quit) for various actions.
90-
```
91+
> [!TIP]
92+
> Inside `htop`, you can use arrow keys to navigate and function keys (like F1 for Help, F3 for Search, F9 for Kill, F10 to Quit) for various actions.
93+
94+
[^tmux]: A tool that lets you switch between several programs in one terminal, detach them, and reattach them later.
95+
[^htop]: It's an improved version of the standard `top` command with a more user-friendly interface.

src/mc.md renamed to content/mc.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Minecraft Servers in Docker
1+
+++
2+
insert_anchor_links = "left"
3+
title = "Minecraft Servers in Docker"
4+
[extra]
5+
go_to_top = true
6+
+++
27

38
I use [itzg/docker-minecraft-server](https://github.com/itzg/docker-minecraft-server) containers whenever possible since they are easy to maintain and run.
49

@@ -15,7 +20,7 @@ docker exec -i mc_server rcon-cli
1520
> [!NOTE]
1621
> This command's ```mc_server``` is a placeholder for whatever you called your container name in your compose file
1722
18-
## Some things to keep in mind
23+
### Some things to keep in mind
1924

2025
There are somethings that you should utilize, regardless of server software. Like online-mode or creating a whitelist.
2126
Enabling both of those options should protect your server from unauthorized visitors.

0 commit comments

Comments
 (0)