Use mkdocs

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: ci 
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: ./project/gradlew javadoc
+
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

docs/CONTRIBUTION.md

@@ -40,7 +40,8 @@ def pubVersion = 'my-new-feature-preview'
 ```
 
 Next, open the project in [IntelliJ](https://www.jetbrains.com/idea/) and click "Publish to Maven Local."
-<img src='./media/publish%20to%20maven%20local.png' style='width: 30%'>
+
+![](./media/publish%20to%20maven%20local.png){ width="30%" }
 
 Now that the library is on your local machine, copy `./docs/vendordep/maple-sim.json` to the vendordeps directory of one of the [templates](https://github.com/Shenzhen-Robotics-Alliance/maple-sim/tree/main/templates) to test your code.
 

docs/index.md

@@ -1,6 +1,6 @@
-<p align="center">
-  <img src="./media/team_logo.png" width="20%"  alt="team logo"/>
-  <img src="./media/icon.png" width="79%"  alt="project logo"/>
+<p align="center" markdown>
+  ![team logo](./media/team_logo.png){ width="20%"}
+  ![project logo](./media/icon.png){ width="79%"}
 </p>
 
 ### Elevating FRC Java Robot Simulations to the Next Level with Physics Engines
@@ -34,14 +34,14 @@ For an in-depth description of the simulations, please refer to [Simulation Deta
 
 Please follow the guides below for quick setup:
 
-1. [Installing maple-sim](https://shenzhen-robotics-alliance.github.io/maple-sim/1_INSTALLING_MAPLE_SIM.html)
-2. [Using the Simulated Arena](https://shenzhen-robotics-alliance.github.io/maple-sim/2_USING_THE_SIMULATED_ARENA.html)
-3. [Simulating Swerve Drivetrain](https://shenzhen-robotics-alliance.github.io/maple-sim/3_SWERVE_SIMULATION_OVERVIEW.html)
-4. [Simulating Intake](https://shenzhen-robotics-alliance.github.io/maple-sim/4_SIMULATING_INTAKE.html)
-5. [Simulating Projectiles](https://shenzhen-robotics-alliance.github.io/maple-sim/5_SIMULATING_PROJECTILES.html)
-6. [Simulating Opponent Robots](https://shenzhen-robotics-alliance.github.io/maple-sim/6_SIMULATING_OPPONENT_ROBOTS.html)
+1. [Installing maple-sim](./installing-maple-sim.md)
+2. [Using the Simulated Arena](./using-the-simulated-arena.md)
+3. [Simulating Swerve Drivetrain](./swerve-simulation-overview.md)
+4. [Simulating Intake](./simulating-intake.md)
+5. [Simulating Projectiles](./simulating-projectiles.md)
+6. [Simulating Opponent Robots](./simulating-opponent-robots.md)
 
-## Java Docs
+# Java Docs
 > 🙏  Big thanks to [nstrike](https://www.chiefdelphi.com/u/nstrike/summary) for all the help in setting up the Java Docs.
 [Official Java Docs](https://shenzhen-robotics-alliance.github.io/maple-sim/javadocs/).
 

docs/1_INSTALLING_MAPLE_SIM.md → docs/installing-maple-sim.md

@@ -13,9 +13,6 @@ Alternatively, you can download the JSON vendordeps file and place it in the `/v
 
 > 💡 If you're using IntelliJ IDEA, remember to click the "Gradle sync" button after configuring the repository.
 
-<div style="display:flex">
-    <h3 style="width:49%"><< Back to: <a href="https://shenzhen-robotics-alliance.github.io/maple-sim/0_SIMULATION_DETIALS.html">Simulation Details</a></h3>
-    <h3 style="width:49%" align="right">Next: <a href="https://shenzhen-robotics-alliance.github.io/maple-sim/2_USING_THE_SIMULATED_ARENA.html">Using the Simulated Arena Object</a> >></h3>
-</div>
+
 
 > 🙏 Big thanks to [nstrike](https://www.chiefdelphi.com/u/nstrike/summary) for all the help in setting up the vendordeps deployment.