fix(lint): fix markdown files issues raised by markdownlint

also fixes checkov issue

Author: thelooter

.github/workflows/lint.yaml

@@ -9,8 +9,7 @@ on:
     branches:
       - main
 
-permissions:
-  contents: read
+permissions: read-all
 
 jobs:
   lint:

.markdownlint.jsonc

@@ -0,0 +1,9 @@
+{
+  "default": true,
+  "MD013": {
+    "code_block_line_length": 120
+  },
+  "MD025": {
+    "front_matter_title": ""
+  }
+}

CONTRIBUTING.md

@@ -1,42 +1,48 @@
 # Contributing to the Mockbukkit Documentation
 
-Thank you for your interest in contributing to our documentation!
-We welcome contributions from the community to help improve and expand our documentation.
+Thank you for your interest in contributing to our documentation! We welcome
+contributions from the community to help improve and expand our documentation.
 
 ## Getting Started
 
 ### Prerequisites
 
-Before you start contributing, ensure you have the following prerequisites installed:
+Before you start contributing, ensure you have the following prerequisites
+installed:
 
 - [Git](https://git-scm.com/)
 - [Node.js](https://nodejs.org/) (version 18.x or higher)
 - [pnpm](https://pnpm.io/)
 
 ### Setting Up the Development Environment
 
-1. **Fork the Repository**: Start by forking the documentation repository to your own GitHub account.
+1. **Fork the Repository**: Start by forking the documentation repository to
+   your own GitHub account.
 
-2. **Clone the Repository**: Next, clone the forked repository to your local machine.
+2. **Clone the Repository**: Next, clone the forked repository to your local
+   machine.
 
    ```bash
    git clone https://github.com/your-username/docs.git
    ```
 
-3. **Install Dependencies**: Install the necessary dependencies for the documentation project.
+3. **Install Dependencies**: Install the necessary dependencies for the
+   documentation project.
 
    ```bash
    cd docs
    pnpm install
    ```
 
-4. **Start the Development Server**: Start the Vitepress development server to preview your changes.
+4. **Start the Development Server**: Start the Vitepress development server to
+   preview your changes.
 
    ```bash
    pnpm run docs:dev
    ```
 
-   The development server will start, and you can access the documentation site at `http://localhost:5173`.
+   The development server will start, and you can access the documentation site
+   at <http://localhost:5173>.
 
 ## Making Changes
 
@@ -46,15 +52,17 @@ Before you start contributing, ensure you have the following prerequisites insta
    git checkout -b my-feature-branch
    ```
 
-2. **Update the Documentation**: Make your changes to the documentation. This could include:
+2. **Update the Documentation**: Make your changes to the documentation. This
+   could include:
 
    - Adding new pages
    - Updating existing content
    - Fixing typos or grammatical errors
    - Improving the organization or structure of the documentation
    - Adding new translations
 
-3. **Preview Your Changes**: Use the Vitepress development server to preview your changes and ensure they look as expected.
+3. **Preview Your Changes**: Use the Vitepress development server to preview
+   your changes and ensure they look as expected.
 
 4. **Commit and Push Your Changes**: Once you're satisfied with your changes,
    commit them and push the branch to your forked repository.
@@ -67,26 +75,32 @@ Before you start contributing, ensure you have the following prerequisites insta
 
 ## Submitting a Pull Request
 
-1. **Create a Pull Request**: Go to the original repository on GitHub and create a new pull request,
-   comparing your feature branch with the main branch of the original repository.
+1. **Create a Pull Request**: Go to the original repository on GitHub and create
+   a new pull request, comparing your feature branch with the main branch of
+   the original repository.
 
 2. **Describe Your Changes**: In the pull request description,
-   provide a clear and concise explanation of the changes you've made and why they are valuable to the project.
+   provide a clear and concise explanation of the changes you've made and why
+   they are valuable to the project.
 
-3. **Address Feedback**: The maintainers may request changes or provide feedback on your pull request.
-   Please be responsive to this feedback and make any necessary updates to your branch.
+3. **Address Feedback**: The maintainers may request changes or provide feedback
+   on your pull request. Please be responsive to this feedback and make any
+   necessary updates to your branch.
 
 ## Coding Style and Guidelines
 
-- Follow the existing coding style and formatting used in the documentation repository.
-- Ensure your changes are consistent with the overall tone and voice of the documentation.
-- Make use of Vitepress's built-in features, such as frontmatter, custom components, and Markdown extensions, where appropriate.
+- Follow the existing coding style and formatting used in the documentation
+  repository.
+- Ensure your changes are consistent with the overall tone and voice of the
+  documentation.
+- Make use of Vitepress's built-in features, such as frontmatter, custom
+  components, and Markdown extensions, where appropriate.
 - Write clear and concise documentation that is easy for users to understand.
 
 ### Code blocks
 
-For code blocks where multiple languages can be used, vitepress provides a way to
-specify blocks for multiple languages. Use the following syntax:
+For code blocks where multiple languages can be used, vitepress provides a way
+to specify blocks for multiple languages. Use the following syntax:
 
 ````md
 ::: code-group
@@ -104,10 +118,12 @@ specify blocks for multiple languages. Use the following syntax:
 
 ## Vitepress Markdown Extensions
 
-Vitepress provides a variety of Markdown extensions that can be used to enhance the documentation.
-You can find a list of available extensions in the [Vitepress documentation](https://vitepress.dev/guide/markdown).
+Vitepress provides a variety of Markdown extensions that can be used to enhance
+the documentation. You can find a list of available extensions in
+the [Vitepress documentation](https://vitepress.dev/guide/markdown).
 
 ## Thank You
 
 We appreciate your contributions to the Mockbukkit documentation.
-By working together, we can create high-quality, user-friendly documentation that benefits the entire community.
+By working together, we can create high-quality, user-friendly documentation
+that benefits the entire community.

README.md

@@ -1,13 +1,15 @@
 # Mockbukkit Docs
 
-This repository is the place where you can find the code for all documentation provided by the
-MockBukkit project. The repository is published under [docs.mockbukkit.org](https://docs.mockbukkit.org).
+This repository is the place where you can find the code for all documentation
+provided by the MockBukkit project. The repository is published under
+[docs.mockbukkit.org](https://docs.mockbukkit.org).
 
 ## Getting started
 
-This is how you can get started working on the docs on your local development machine.
+This is how you can get started working on the docs on your local development
+machine.
 
-### Prerequisites:
+### Prerequisites
 
 - [node](https://nodejs.org)
 - [pnpm](https://pnpm.io/)
@@ -33,7 +35,8 @@ This is how you can get started working on the docs on your local development ma
    pnpm docs:build // build for production
    ```
 
-In the case of building for production, the site will be generated in the `.vitepress/dist` directory.
+In the case of building for production, the site will be generated in the
+`.vitepress/dist` directory.
 
 ### Previewing
 
@@ -44,15 +47,20 @@ pnpm docs:preview
 ```
 
 This will start a local server on port 5173.
-You can then access the site at http://localhost:5173.
+You can then access the site at <http://localhost:5173>.
 
 ## Contributing
 
-Contributions are welcome! Please read the [contribution guidelines](https://github.com/MockBukkit/docs/blob/main/CONTRIBUTING.md) before submitting a pull request.
+Contributions are welcome! Please read the
+<!-- markdownlint-disable-next-line MD013 -->
+[contribution guidelines](https://github.com/MockBukkit/docs/blob/main/CONTRIBUTING.md)
+before submitting a pull request.
 
 ## License
 
 The MockBukkit documentation is licensed under two licenses:
 
-- Docs: [Creative Commons Attribution-ShareAlike 4.0 International](https://github.com/MockBukkit/docs/blob/main/docs/LICENSE)
-- Supporting Code: [MIT License](https://github.com/MockBukkit/docs/blob/main/LICENSE)
+- Docs:
+  [Creative Commons Attribution-ShareAlike 4.0 International](https://github.com/MockBukkit/docs/blob/main/docs/LICENSE)
+- Supporting Code:
+- [MIT License](https://github.com/MockBukkit/docs/blob/main/LICENSE)

docs/en/contribution/maintainers/pr_guide.md

@@ -13,16 +13,20 @@ and attract new people to help drive this project forward!
 
 :::
 
-We use [GitHub Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels)
-to automatically tag PRs with a version number on merge. This removes the tedious work of keeping version numbers up
-to date across several PRs at a time and eliminate Human error. The following custom labels, all of them following the
+We
+use [GitHub Labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels)
+to automatically tag PRs with a version number on merge. This removes the
+tedious work of keeping version numbers up
+to date across several PRs at a time and eliminate Human error. The following
+custom labels, all of them following the
 pattern of `release/*`, are used by Mockbukkit:
 
-| Label                                        | Semantic Version Type |     | Description                            |
-| -------------------------------------------- | :-------------------- | :-- | :------------------------------------- |
-| <Badge type="danger" text="release/major"/>  | Major Version (X.0.0) |     | Only used for breaking changes         |
-| <Badge type="warning" text="release/minor"/> | Minor Version (0.X.0) |     | New Features                           |
-| <Badge type="tip" text="release/patch"/>     | Patch Version (0.0.X) |     | Bugfixes                               |
-| <Badge type="info" text="release/none"/>     | None (-)              |     | Method Stubs or non code related fixes |
+| Label | Semantic Version Type | | Description | <!-- markdownlint-disable-line MD033 MD013 -->
+|----------------------------------------------|:----------------------|:----|:---------------------------------------| <!-- markdownlint-disable-line MD033 MD013 -->
+| <Badge type="danger" text="release/major"/> | Major Version (X.0.0) | | Only used for breaking changes | <!-- markdownlint-disable-line MD033 MD013 -->
+| <Badge type="warning" text="release/minor"/> | Minor Version (0.X.0) | | New Features | <!-- markdownlint-disable-line MD033 MD013 -->
+| <Badge type="tip" text="release/patch"/> | Patch Version (0.0.X) | | Bugfixes | <!-- markdownlint-disable-line MD033 MD013 -->
+| <Badge type="info" text="release/none"/> | None (-) | | Method Stubs or non code related fixes | <!-- markdownlint-disable-line MD033 MD013 -->
 
-As you can probably tell, this project uses [Semantic Versioning](https://semver.org/).
+As you can probably tell, this project
+uses [Semantic Versioning](https://semver.org/).

docs/en/user_guide/advanced/adventure.md

@@ -11,7 +11,8 @@ prev:
 
 ::: info
 
-This talks about the [Kyori Adventure](https://github.com/KyoriPowered/adventure-platform) Library.
+This talks about the
+[Kyori Adventure](https://github.com/KyoriPowered/adventure-platform)Library.
 This has no connection to the Adventure Gamemode
 
 :::
@@ -20,10 +21,11 @@ This has no connection to the Adventure Gamemode
 
 When using MockBukkit with the non-native implementation of Adventure,
 you may run into issues with static fields persisting with `Audiences`,
-even after executing `MockBukkit.unmock()`.
-This can cause undesired issues when running consecutive tests like chat messages not sending.
+even after executing `MockBukkit.unmock()`.This can cause undesired issues when
+running consecutive tests like chat messages not sending.
 
-The solution is to include a `platform.close()` statement in the `onDisable()` method of your plugin.
+The solution is to include a `platform.close()` statement in the `onDisable()`
+method of your plugin.
 
 ::: code-group
 

docs/en/user_guide/advanced/custom_server_mock.md

@@ -11,10 +11,12 @@ next:
 
 # Create a Custom Server Mock
 
-Sometimes it may be needed to use a custom implementation of the `ServerMock` class.
-This could be if you want to implement some of the unimplemented methods or simply provide your own mocks for certain methods.
+Sometimes it may be needed to use a custom implementation of the `ServerMock`
+class. This could be if you want to implement some of the unimplemented methods
+or simply provide your own mocks for certain methods.
 
-To do that you can simply pass your custom mock that extends `ServerMock` to the `MockBukkit#mock(ServerNock)` method.
+To do that you can simply pass your custom mock that extends `ServerMock` to the
+`MockBukkit#mock(ServerNock)` method.
 
 ::: code-group
 

docs/en/user_guide/advanced/events.md

@@ -11,18 +11,18 @@ next:
 
 # Events
 
-Checking the status of events is one of the most common task done by any Bukkit Developer.
-Therefore Mockbukkit provides support for these kind of tasks.
+Checking the status of events is one of the most common task done by any Bukkit
+Developer. Therefore, MockBukkit provides support for these kinds of tasks.
 
 ## Asserting that Events were fired
 
-Mockbukkit provides a way to check if Events are fired.
-Events are Classes that extend `org.bukkit.event.Event` and are fired by Bukkit.
+Mockbukkit provides a way to check if Events are fired.Events are Classes that
+extend `org.bukkit.event.Event` and are fired by Bukkit.
 
-To check if an event is fired,
-you can use the `PluginManagerMock#assertEventFired(Class<? extends Event>)` method.
-This method takes a class that extends `org.bukkit.event.Event`.
-It will then check if an event of that type was fired.
+To check if an event is fired, you can use the
+`PluginManagerMock#assertEventFired(Class<? extends Event>)`method. This method
+takes a class that extends `org.bukkit.event.Event`. It will then check if an
+event of that type was fired.
 
 ::: code-group
 
@@ -79,8 +79,10 @@ class MyPluginTests {
 
 ### Assert Event with specific values
 
-If you want to check if an event was fired with a specific value,
-you can use the `PluginManagerMock#assertEventFired(Class<? extends Event>, Predicate<Event>)` method.
+If you want to check if an event was fired with a specific value, you can use
+the
+`PluginManagerMock#assertEventFired(Class<? extends Event>, Predicate<Event>)`
+method.
 
 ::: code-group
 
@@ -139,10 +141,10 @@ class MyPluginTests {
 
 :::
 
-### Custom Failure Message
+### Custom Failure Message with `assertEventFired`
 
-You can also set a custom failure message for the assertion
-by using the `PluginManagerMock#assertEventFired(Class<? extends Event>, String)` method.
+You can also set a custom failure message for the assertion by using the
+`PluginManagerMock#assertEventFired(Class<? extends Event>, String)` method.
 
 ::: code-group
 
@@ -199,8 +201,8 @@ class MyPluginTests {
 
 ## Asserting that Events were not fired
 
-You can also check if an event was not fired by
-using the `PluginManagerMock#assertEventNotFired(Class<? extends Event>)` method.
+You can also check if an event was not fired by using the
+`PluginManagerMock#assertEventNotFired(Class<? extends Event>)` method.
 
 ::: code-group
 
@@ -253,10 +255,10 @@ class MyPluginTests {
 }
 ```
 
-### Custom Failure Message
+### Custom Failure Message with `assertEventNotFired`
 
-You can also set a custom failure message for the assertion by
-using the `PluginManagerMock#assertEventNotFired(Class<? extends Event>, String)` method.
+You can also set a custom failure message for the assertion by using the
+`PluginManagerMock#assertEventNotFired(Class<? extends Event>, String)` method.
 
 ::: code-group