Formatted markdown files

LifeAdventurer · Nov 10, 2024 · ed39495 · ed39495
1 parent 8cf3286
commit ed39495
Show file tree

Hide file tree

Showing 4 changed files with 94 additions and 60 deletions.
diff --git a/docs/portfolio/mkdocs-material-template.md b/docs/portfolio/mkdocs-material-template.md
@@ -1,15 +1,19 @@
 # A Material for MkDocs Documentation Template
 
-This template uses MkDocs with the Material theme to create elegant, responsive, and well-structured documentation for your projects.
+This template uses MkDocs with the Material theme to create elegant, responsive,
+and well-structured documentation for your projects.
 
 ## Getting Started
 
-This repository is a [template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
-You can create your repository by clicking the `Use this template` button on the upper right corner.
+This repository is a
+[template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
+You can create your repository by clicking the `Use this template` button on the
+upper right corner.
 
 ## Prerequisites
 
 Before you begin, make sure you have the following installed:
+
 - Python (version 3.8 or higher)
 - Poetry (recommended)
 - or pip
@@ -19,66 +23,75 @@ Before you begin, make sure you have the following installed:
 ### Using Poetry (recommended)
 
 1. Clone the repository:
-    ```shell
-    git clone https://github.com/<username>/<repo-name>.git
-    cd <repo-name>
-    ```
+   ```shell
+   git clone https://github.com/<username>/<repo-name>.git
+   cd <repo-name>
+   ```
 2. Install dependencies:
-    ```shell
-    poetry install
-    ```
+   ```shell
+   poetry install
+   ```
 3. Activate the virtual environment:
-    ```shell
-    poetry shell
-    ```
+   ```shell
+   poetry shell
+   ```
 
 ### Using pip
 
 1. Clone the repository:
-    ```shell
-    git clone https://github.com/<username>/<repo-name>.git
-    cd <repo-name>
-    ```
+   ```shell
+   git clone https://github.com/<username>/<repo-name>.git
+   cd <repo-name>
+   ```
 2. Create and activate a virtual environment:
-    ```shell
-    python -m venv venv
-    source venv/bin/activate # On Windows use `venv\Scripts\activate`
-    ```
+   ```shell
+   python -m venv venv
+   source venv/bin/activate # On Windows use `venv\Scripts\activate`
+   ```
 3. Install dependencies:
-    ```shell
-    pip install -r requirements.txt
-    ```
+   ```shell
+   pip install -r requirements.txt
+   ```
 
 ## Usage
 
 1. Preview the documentation:
-    ```shell
-    mkdocs serve
-    ```
-    Your documentation site will be available at `https://localhost:8000/`.
+   ```shell
+   mkdocs serve
+   ```
+   Your documentation site will be available at `https://localhost:8000/`.
 
 2. Build the documentation for deployment:
-    ```shell
-    mkdocs build
-    ```
-    The static site will be generated in the `site` directory.
+   ```shell
+   mkdocs build
+   ```
+   The static site will be generated in the `site` directory.
 3. Deploy to GitHub Pages:
-    ```shell
-    mkdocs gh-deploy
-    ```
-    This command will deploy your site to the `gh-pages` branch of your repository and make it available on GitHub Pages.
+   ```shell
+   mkdocs gh-deploy
+   ```
+   This command will deploy your site to the `gh-pages` branch of your
+   repository and make it available on GitHub Pages.
 
 ## Configuration
 
-Configure your documentation by editing the `mkdocs.yml` file. This file contains various settings such as theme, extension, and navigation structure. For more information, refer to the [Material for MkDocs Documentation](https://squidfunk.github.io/mkdocs-material/)
+Configure your documentation by editing the `mkdocs.yml` file. This file
+contains various settings such as theme, extension, and navigation structure.
+For more information, refer to the
+[Material for MkDocs Documentation](https://squidfunk.github.io/mkdocs-material/)
 
 ## Acknowledgements
 
 This template is built using the following open-source projects:
 
-- [MkDocs](https://github.com/mkdocs/mkdocs/): A fast, simple and downright gorgeous static site generator that's geared towards building project documentation.
-- [Material for MkDocs](https://github.com/squidfunk/mkdocs-material): A Material Design theme for MkDocs, created by Martin Donath (Squidfunk).
+- [MkDocs](https://github.com/mkdocs/mkdocs/): A fast, simple and downright
+  gorgeous static site generator that's geared towards building project
+  documentation.
+- [Material for MkDocs](https://github.com/squidfunk/mkdocs-material): A
+  Material Design theme for MkDocs, created by Martin Donath (Squidfunk).
 
 ## LICENSE
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/LifeAdventurer/mkdocs-material-template/blob/main/LICENSE) file for details.
+This project is licensed under the MIT License - see the
+[LICENSE](https://github.com/LifeAdventurer/mkdocs-material-template/blob/main/LICENSE)
+file for details.
diff --git a/docs/portfolio/moonafly.md b/docs/portfolio/moonafly.md
@@ -4,4 +4,5 @@ Moonafly is a discord bot with a lot useful features.
 
 ## Documentation
 
-For detailed information on Moonafly's commands and features, refer to [documentation](https://Moonafly.github.io/docs/)
+For detailed information on Moonafly's commands and features, refer to
+[documentation](https://Moonafly.github.io/docs/)
diff --git a/docs/portfolio/permission-tree.md b/docs/portfolio/permission-tree.md
@@ -1,6 +1,9 @@
 # Permission Tree
 
-A tree structure that manages permissions and allows moving subtrees. This project implements a simple permission tree where each node can be public or private. When a public subtree is moved to a private node, the entire subtree becomes private.
+A tree structure that manages permissions and allows moving subtrees. This
+project implements a simple permission tree where each node can be public or
+private. When a public subtree is moved to a private node, the entire subtree
+becomes private.
 
 ## Features
 
@@ -13,15 +16,17 @@ A tree structure that manages permissions and allows moving subtrees. This proje
 
 ### Prerequisites
 
-Ensure you have [Rust](https://www.rust-lang.org/) installed on your machine. You can install it using `rustup`:
+Ensure you have [Rust](https://www.rust-lang.org/) installed on your machine.
+You can install it using `rustup`:
 
 ```sh
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```
 
 ### Installation
 
-To use the `permission-tree` library in your project, add it as a dependency in your `Cargo.toml` file:
+To use the `permission-tree` library in your project, add it as a dependency in
+your `Cargo.toml` file:
 
 ```toml
 [dependencies]
@@ -72,4 +77,7 @@ cargo test
 
 ## License
 
-This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the [`LICENSE`](https://github.com/LifeAdventurer/permission-tree/blob/main/LICENSE) file for more details.
+This project is licensed under the GNU General Public License v3.0 (GPL-3.0).
+See the
+[`LICENSE`](https://github.com/LifeAdventurer/permission-tree/blob/main/LICENSE)
+file for more details.
diff --git a/docs/portfolio/typing-contest-bot.md b/docs/portfolio/typing-contest-bot.md
@@ -1,7 +1,8 @@
 # Typing Contest Discord Bot
 
-This is a Discord bot built with `discord.py` to facilitate typing contests in a server. The bot enables users to start contests, join them, submit WPM (words per minute) results, and display rankings based on average WPM.
-
+This is a Discord bot built with `discord.py` to facilitate typing contests in a
+server. The bot enables users to start contests, join them, submit WPM (words
+per minute) results, and display rankings based on average WPM.
 
 ## Prerequisties
 
@@ -10,7 +11,6 @@ This is a Discord bot built with `discord.py` to facilitate typing contests in a
 
 ## Installation
 
-
 ### 1. Clone the repository:
 
 ```sh
@@ -57,14 +57,15 @@ pip install -r requirements.txt
 
 ### 3. Configure the bot:
 
-Create a `config.json` file in the `./config/` directory with the following structure:
+Create a `config.json` file in the `./config/` directory with the following
+structure:
 
 ```json
 {
-    "token": "your-discord-bot-token",
-    "typist_role_name": "your-server-typist-role",
-    "testing_role_name": "your-server-testing-role", // Optional, required only for debug mode
-    "contests_held": 0
+  "token": "your-discord-bot-token",
+  "typist_role_name": "your-server-typist-role",
+  "testing_role_name": "your-server-testing-role", // Optional, required only for debug mode
+  "contests_held": 0
 }
 ```
 
@@ -84,21 +85,32 @@ python main.py # Or `poetry run python main.py` if using Poetry
 - `!join`: Join the typing contest.
 - `!quit`: Quit the typing contest.
 - `!list`: Display all current participants in the typing contest.
-- `!next`: Proceed to the next round in the typing contest and view the current WPM results.
+- `!next`: Proceed to the next round in the typing contest and view the current
+  WPM results.
 - `!wpm {wpm}`: Submit your WPM result for the current round.
-- `!result`: View the WPM results table at any time, not just after advancing rounds.
-- `!remind`: Sends a reminder to participants who haven't submitted their WPM for the current round. Use this if the round has ended and some participants have not yet submitted their results.
-- `!remove {member}`: Remove a participant from the typing contest. Only the contest creator can use this.
-- `!ban {member}`: Ban a participant from the typing contest. Once banned, they cannot join again. Only the contest creator can use this.
+- `!result`: View the WPM results table at any time, not just after advancing
+  rounds.
+- `!remind`: Sends a reminder to participants who haven't submitted their WPM
+  for the current round. Use this if the round has ended and some participants
+  have not yet submitted their results.
+- `!remove {member}`: Remove a participant from the typing contest. Only the
+  contest creator can use this.
+- `!ban {member}`: Ban a participant from the typing contest. Once banned, they
+  cannot join again. Only the contest creator can use this.
 - `!getrole`: Assign yourself the typist role.
 - `!commands`: Show this list of commands.
 
 ## Contributing
 
-Please see the [CONTRIBUTING.md](https://github.com/LifeAdventurer/typing-contest-bot/blob/main/CONTRIBUTING.md) for guidelines on contributing to this project.
+Please see the
+[CONTRIBUTING.md](https://github.com/LifeAdventurer/typing-contest-bot/blob/main/CONTRIBUTING.md)
+for guidelines on contributing to this project.
 
 ## License
 
-This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the [`LICENSE`](https://github.com/LifeAdventurer/typing-contest-bot/blob/main/LICENSE) file for details.
+This project is licensed under the GNU General Public License v3.0 (GPL-3.0).
+See the
+[`LICENSE`](https://github.com/LifeAdventurer/typing-contest-bot/blob/main/LICENSE)
+file for details.
 
 <h2 align="center">Happy Typing and Good Luck!</h2>