Added documentations with MKDocs

Author: sysmonyx

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci 
+on:
+  push:
+    branches:
+      - master 
+      - 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

docs/customizations/index.md

@@ -0,0 +1 @@
+# Customizations

docs/how-to-use/index.md

@@ -0,0 +1 @@
+# How to Use

docs/index.md

@@ -0,0 +1,5 @@
+# Home
+
+Welcome to the documentation for Linux Scripts by sysmonyx
+
+## Objectives

mkdocs.yml

@@ -0,0 +1,69 @@
+# Site details
+site_name: Linux Scripts
+repo_name: sysmonyx/linux-scripts
+repo_url: https://github.com/sysmonyx/linux-scripts
+
+# Static details
+copyright: Copyright © 2025 Soham Ray @sysmonyx
+
+# Material for MKDocs theme configs
+theme:
+  icon:
+    logo: fontawesome/brands/linux
+    repo: fontawesome/brands/github
+  name: material
+  palette:
+    # Palette toggle for light mode
+    - scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    
+    # Palette toggle for dark mode
+    - scheme: slate
+      primary: black
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+        
+  font:
+    text: IBM Plex Sans
+    code: IBM Plex Mono
+  features:
+    - navigation.instant
+    - navigation.tabs
+    - navigation.sections
+    - navigation.indexes
+    - navigation.path
+    - navigation.top
+    - navigation.prune
+    - navigation.tracking
+
+# Navigation Configs
+nav:
+  - Home:
+    - index.md
+  - How to Use:
+    - how-to-use/index.md
+  - Customizations:
+    - customizations/index.md
+
+# Extra Optimizations, Customizations, Plugins & Extensions
+extra:
+  generator: false
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/sysmonyx
+      name: sysmonyx on GitHub
+    - icon: fontawesome/brands/gitlab
+      link: https://gitlab.com/sysmonyx
+      name: sysmonyx on GitLab
+    - icon: fontawesome/solid/paper-plane
+      link: mailto:contact@sysmonyx.com
+      name: Email
+
+#extra_css:
+#  - stylesheets/extra.css