Add Markdown lint/format

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,3 @@
-
 ## STOP AND READ BEFORE SUBMITTING! REMOVE THIS PARAGRAPH BEFORE OPENING THE PR
 
 Thank you for your interest in contributing to OWASP Nest!

.markdownlint.yaml

@@ -0,0 +1,25 @@
+default: true
+
+# MD003/heading-style
+MD003:
+  style: atx
+
+# MD004/ul-style
+MD004:
+  style: dash
+
+# MD013/line-length
+MD013: false
+
+# MD024/no-duplicate-heading
+MD024: false
+
+# MD033/no-inline-html
+MD033: false
+
+# MD041/first-line-heading
+MD041: false
+
+# MD046/code-block-style
+MD046:
+  style: fenced

.pre-commit-config.yaml

@@ -40,6 +40,14 @@ repos:
         types:
           - html
 
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.47.0
+    hooks:
+      - id: markdownlint
+        args:
+          - --fix
+        files: \.md$
+
   - repo: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt
     rev: 0.2.3
     hooks:

CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities

README.md

@@ -68,6 +68,6 @@ Over time, OWASP Nest has expanded to address broader OWASP community needs, suc
 
 ### Community and Social Media
 
-- [BlueSky account](https://bsky.app/profile/nest.owasp.org)
-- [LinkedIn group](https://www.linkedin.com/groups/14656108/)
-- [Slack channel](https://owasp.slack.com/archives/project-nest) (join [here](https://owasp.org/slack/invite))
+- [BlueSky](https://bsky.app/profile/nest.owasp.org)
+- [LinkedIn](https://www.linkedin.com/groups/14656108/)
+- [OWASP Slack](https://owasp.slack.com/archives/project-nest) -- join [#project-nest](https://owasp.org/slack/invite)

docs/code-of-conduct.md

@@ -1,3 +1,5 @@
+<!-- Disabling MD046 to preserve MkDocs rendering -->
+<!-- markdownlint-disable MD046 -->
 # Code of Conduct
 
 ## Our Pledge
@@ -19,11 +21,11 @@
 
 We encourage behaviors that contribute to a positive environment:
 
--  Demonstrating empathy and kindness toward other people
--  Being respectful of differing opinions, viewpoints, and experiences
--  Giving and gracefully accepting constructive feedback
--  Accepting responsibility and apologizing for mistakes
--  Focusing on what is best for the overall community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing for mistakes
+- Focusing on what is best for the overall community
 
 ### Unacceptable Behaviors
 
@@ -39,6 +41,7 @@ We encourage behaviors that contribute to a positive environment:
 ### Responsibilities
 
 !!! info "Leadership Role"
+
     Community leaders are responsible for:
 
     - Clarifying and enforcing standards of acceptable behavior
@@ -82,8 +85,6 @@ Community leaders follow these impact guidelines when determining consequences:
 
 This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html), version 2.0, available at [contributor-covenant.org](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
 
-
-
 Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 !!! note "Additional Resources"

docs/contributing.md

@@ -1,3 +1,5 @@
+<!-- Disabling MD046 to preserve MkDocs rendering -->
+<!-- markdownlint-disable MD046 -->
 # Contributing to Nest
 
 !!! note "Thank You"
@@ -7,9 +9,9 @@
 
 Nest is a full-stack web application built using:
 
-* **Backend**: Python, Django
-* **Frontend**: TypeScript, React, Tailwind CSS
-* **Search**: Algolia
+- **Backend**: Python, Django
+- **Frontend**: TypeScript, React, Tailwind CSS
+- **Search**: Algolia
 
 !!! info "Containerization"
     The project uses a **containerized approach** for both development and production environments. Docker is required to run Nest locally.
@@ -21,15 +23,15 @@ Before contributing, ensure you have the following installed:
 ### Required Tools
 
 1. **Docker**
-    * Required for running the Nest instance
-    * [Docker Documentation](https://docs.docker.com/)
+    - Required for running the Nest instance
+    - [Docker Documentation](https://docs.docker.com/)
 
 2. **pre-commit**
-    * Required to automate code checks and apply fixes
-    * Installation options:
-        * Virtual environment: `pip install pre-commit`
-        * OS package: `apt install pre-commit` / `brew install pre-commit`
-        * Other methods depending on your configuration
+    - Required to automate code checks and apply fixes
+    - Installation options:
+        - Virtual environment: `pip install pre-commit`
+        - OS package: `apt install pre-commit` / `brew install pre-commit`
+        - Other methods depending on your configuration
 
 ### Windows Users Requirements
 
@@ -55,9 +57,9 @@ Before contributing, ensure you have the following installed:
 
 ### Support the Project
 
-* [![GitHub stars](https://img.shields.io/github/stars/OWASP/Nest?style=social)](https://github.com/OWASP/Nest)
+- [![GitHub stars](https://img.shields.io/github/stars/OWASP/Nest?style=social)](https://github.com/OWASP/Nest)
 
-* [![GitHub forks](https://img.shields.io/github/forks/OWASP/Nest?style=social)](https://github.com/OWASP/Nest/fork)
+- [![GitHub forks](https://img.shields.io/github/forks/OWASP/Nest?style=social)](https://github.com/OWASP/Nest/fork)
 
 ### Initial Setup
 
@@ -218,9 +220,9 @@ To fetch GitHub OWASP data locally:
     ```
 
 3. **Configure Slack App**
-    * Use [NestBot manifest file](https://github.com/OWASP/Nest/blob/main/backend/apps/slack/MANIFEST.yaml) (copy its contents and save it into `Features -- App Manifest`).
-    * Replace slash commands endpoint with your ngrok domain
-    * Reinstall your Slack application after making the changes using `Settings -- Install App` section
+    - Use [NestBot manifest file](https://github.com/OWASP/Nest/blob/main/backend/apps/slack/MANIFEST.yaml) (copy its contents and save it into `Features -- App Manifest`).
+    - Replace slash commands endpoint with your ngrok domain
+    - Reinstall your Slack application after making the changes using `Settings -- Install App` section
 
 ## Development Guidelines
 
@@ -247,8 +249,8 @@ make test
 
 #### Test Coverage
 
-* Minimum test coverage requirement for the Backend: [pyproject.toml](https://github.com/OWASP/Nest/blob/main/backend/pyproject.toml)
-* Minimum test coverage requirement for the Frontend: [jest.config.ts](https://github.com/OWASP/Nest/blob/main/frontend/jest.config.ts)
+- Minimum test coverage requirement for the Backend: [pyproject.toml](https://github.com/OWASP/Nest/blob/main/backend/pyproject.toml)
+- Minimum test coverage requirement for the Frontend: [jest.config.ts](https://github.com/OWASP/Nest/blob/main/frontend/jest.config.ts)
 
 !!! danger "Important Notice"
     - Ensure your changes do not drop the overall test coverage percentage.
@@ -258,8 +260,8 @@ make test
 
 ### 1. Find an Issue
 
-* Browse [issues](https://github.com/owasp/nest/issues)
-* If you want to work on something specific, create a new issue or comment on an existing one to let others know
+- Browse [issues](https://github.com/owasp/nest/issues)
+- If you want to work on something specific, create a new issue or comment on an existing one to let others know
 
 ### 2. Branch Creation
 
@@ -270,23 +272,23 @@ git checkout -b feature/my-feature-name
 
 ### 3. Make Changes and Commit
 
-* Check that your commits include only related and intended changes. Do not include unrelated files.
-* Follow best practices for code style and testing.
+- Check that your commits include only related and intended changes. Do not include unrelated files.
+- Follow best practices for code style and testing.
 
 - **Add tests** for any new functionality or changes to ensure proper coverage.
-  * **Run the code quality checks**:
+  - **Run the code quality checks**:
 
       ```bash
       make check
       ```
 
-  * **Run tests to ensure everything works correctly**:
+  - **Run tests to ensure everything works correctly**:
 
       ```bash
       make test
       ```
 
-  * **Write meaningful commit messages**:
+  - **Write meaningful commit messages**:
 
       ```bash
       git commit -m "Add feature: short description"
@@ -302,13 +304,13 @@ git checkout -b feature/my-feature-name
 
 ### 5. Pull Request
 
-* Submit a **Pull Request** (PR) to the `main` branch
-* Your PR will trigger CI/CD pipelines that run automated checks and tests
+- Submit a **Pull Request** (PR) to the `main` branch
+- Your PR will trigger CI/CD pipelines that run automated checks and tests
 
 ### 6. Review Process
 
-* Address feedback from maintainers during code review.
-* Once approved, your PR will be merged into the main branch.
+- Address feedback from maintainers during code review.
+- Once approved, your PR will be merged into the main branch.
 
 ## Troubleshooting
 
@@ -320,9 +322,9 @@ This error is usually caused by incorrect encoding of `.env` files. To resolve t
 
 1. **Open the `.env` file in a text editor** (e.g., Visual Studio Code).
 2. **Check and change the encoding**:
-   * Click on the encoding information in the bottom-right corner of the VS Code window.
-   * Select **"Save with Encoding"**.
-   * Choose **"UTF-8"** from the list (ensure it's not "UTF-8 with BOM").
+   - Click on the encoding information in the bottom-right corner of the VS Code window.
+   - Select **"Save with Encoding"**.
+   - Choose **"UTF-8"** from the list (ensure it's not "UTF-8 with BOM").
 3. **Save the file** with the correct encoding.
 4. **Restart the application** using the command
    **`make run`**.

docs/index.md

@@ -2,6 +2,7 @@
 title: OWASP Nest
 ---
 
+<!-- markdownlint-disable MD025 -->
 # OWASP Nest
 
 [![OWASP](https://img.shields.io/badge/OWASP-Incubator-blue)](https://owasp.org/www-project-nest/) ![OWASP](https://img.shields.io/badge/OWASP-Code-blue) [![Slack](https://img.shields.io/badge/OWASP-Slack-blue.svg)](https://owasp.slack.com/messages/project-nest)
@@ -32,7 +33,7 @@ OWASP Nest makes it easier for both new and experienced contributors to engage m
 OWASP Nest is led by a dedicated team ensuring the platform aligns with OWASP’s mission and fosters a thriving open-source ecosystem.
 
 | **Leader** | **GitHub Profile** |
-|------------|------------------|
+| ------------ | ------------------ |
 | Arkadii Yakovets | [@arkid15r](https://github.com/arkid15r/) |
 | Kate Golovanova | [@kasya](https://github.com/kasya/) |
 | Starr Brown | [@mamicidal](https://github.com/mamicidal/) |