Online documentation for GitHub Pages (#17)

* Doc v0

* Change npm i to npm ci

* v0.1

* More doc :)

* links to ML & OX

* fix doc

---------

Co-authored-by: Nicolas Vuillamy <[email protected]>
Co-authored-by: itayox <[email protected]>

.github/workflows/build-deploy-docs.yml

@@ -0,0 +1,35 @@
+name: "DOC - Build and deploy - Beta"
+on:
+  push:
+    branches:
+      - main
+      - development
+      - docs
+    paths:
+      - "docs/**"
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    if: github.repository == 'oxsecurity/codetotal'
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/[email protected]
+        with:
+          python-version: 3.10.4
+      - run: pip install --upgrade markdown==3.3.7 mkdocs-material pymdown-extensions==9.11 mkdocs-glightbox==0.3.2 mdx_truly_sane_lists
+      - run: |
+          git config --global user.name megalinter-bot
+          git config --global user.email [email protected]
+      - run: mkdocs gh-deploy --force
+
+

.github/workflows/build.yml

@@ -26,7 +26,7 @@ jobs:
 
       # Runs a single command using the runners shell
       - name: Install deps
-        run: npm i
+        run: npm ci
 
       - name: Lint
         run: npm run lint

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] (beta, main branch content)
+
+Initial version