feat: ✨ Add mkdocs web site

frack113 · Jan 5, 2025 · 2175df7 · 2175df7
1 parent c649bf4
commit 2175df7
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 0 deletions.
diff --git a/.github/workflows/mkdoc.yaml b/.github/workflows/mkdoc.yaml
@@ -0,0 +1,28 @@
+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: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,11 @@
+# Malware Traces Generator
+
+
+## Build or Run
+
+To build just type the command ` cargo build -r`.
+
+To run from source : `cargo run `
+
+## to be fill
+
diff --git a/docs/logo.svg b/docs/logo.svg
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,9 @@
+site_name: Malware Traces Generator
+
+theme:
+  name: readthedocs
+  highlightjs: true
+  hljs_languages:
+    - yaml
+    - rust
+  logo: logo.svg