Platformoon Docs

Welcome to the documentation for Platformoon Docs! This README will guide you on how to set up and run this documentation locally.

Prerequisites

Before you start, make sure you have the following prerequisites installed on your system:

• Python (3.6 or higher)
• pip
• MkDocs
• MkDocs-Material

Getting Started

1. Clone the repository to your local machine:

   git clone <repository_url>

2. Change your working directory to the project's root folder:

   cd <repository_directory>

3. Install packages:

   pip install mkdocs
   pip install mkdocs-material

4. Build the documentation:

   mkdocs build

5. Serve the documentation locally:

   mkdocs serve

6. Open your web browser and navigate to http://localhost:8000 to view the documentation.

Contibution Guide

If you'd like to contribute to this documentation, follow these steps:

1. Fork this repository on GitHub.

2. Create a new branch for your changes:

   git checkout -b add-new-docs

3. Make your changes to the documentation.

4. Test your changes locally by following the "Getting Started" instructions.

5. Commit your changes and push them to your forked repository:

   git add .
   git commit -m "Add new documentation"
   git push origin add-new-docs

6. Create a Pull Request (PR) on the original repository, explaining your changes and why they should be merged.