Migrate documentation to mkdocs

Author: julien-duponchelle

.github/workflows/documentation.yml

@@ -0,0 +1,19 @@
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation with Mkdocs
+mkdocs:
+   configuration: mkdocs.yml
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

.readthedocs.yaml

@@ -1,8 +1,6 @@
-Use a custom Certificate Authority (CA)
-=======================================
+# Use a custom Certificate Authority (CA)
 
-
-.. danger::
+!!! danger "Security Warning"
     When using a custom CA bundle, ensure that nobody else can access the private key of your CA certificate.
     If an attacker gains access to the private key, they could potentially intercept and decrypt your HTTPS traffic.
     This is a significant security risk, so handle the CA private key with care and trust this CA only
@@ -12,22 +10,19 @@ Use a custom Certificate Authority (CA)
     Use dedicated browser instance or load the CA certificate only in specific applications
     where you need to intercept HTTPS traffic.
 
-
 A certificate authority (CA) is used to sign the certificates for the domains you proxy.
 By default your system's trusted CA bundle is used to validate the certificates of the target servers.
 
-To incerpt HTTPS traffic, you need to create your own CA certificate and configure your system or application
+To intercept HTTPS traffic, you need to create your own CA certificate and configure your system or application
 to trust this CA. This allows the proxy to generate and sign certificates for the target domains on-the-fly,
 allowing it to decrypt and inspect the HTTPS traffic.
 
-Usage of custom CA in your applications
-----------------------------------------
+## Usage of custom CA in your applications
 
-Curl
-^^^^^^^^^^^^
-To use a custom CA bundle with curl, you can use the `--cacert` option to specify the path to your CA certificate file.
+### Curl
 
-.. code-block:: console
-
-   $ curl --cacert ca_certificate.pem --proxy http://127.0.0.1:8888 https://httpbin.org/get
+To use a custom CA bundle with curl, you can use the `--cacert` option to specify the path to your CA certificate file.
 
+```console
+curl --cacert ca_certificate.pem --proxy http://127.0.0.1:8888 https://httpbin.org/get
+```