Initial commit

Author: shadil-rayyan

.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/index.md

@@ -0,0 +1,72 @@
+# MkDocs Material Template
+
+A complete starter template showcasing **all major MkDocs Material features**.
+
+---
+
+## ✨ Included Examples
+
+- Admonitions
+- Tabs
+- Code blocks
+- Tables
+- Diagrams
+- Icons & Emojis
+
+# Code Blocks
+
+## Basic Code Block
+
+```python
+def hello():
+    print("Hello, MkDocs!")
+
+---
+
+## 4️⃣ Tabs Example (`markdown/tabs.md`)
+
+```md
+# Tabs
+
+=== "Python"
+    ```python
+    print("Hello from Python")
+    ```
+
+=== "JavaScript"
+    ```js
+    console.log("Hello from JavaScript");
+    ```
+
+=== "Bash"
+    ```bash
+    echo "Hello from Bash"
+    ```
+# Tables
+
+| Feature | Supported |
+|--------|-----------|
+| Tabs   | ✅ |
+| Icons  | ✅ |
+| Diagrams | ✅ |
+
+
+# Icons & Emojis
+
+## Icons
+
+:material-home: Home  
+:material-github: GitHub  
+
+## Emojis
+
+:rocket:  :fire:
+
+
+# Diagrams
+
+```mermaid
+graph TD
+    A[User] --> B[MkDocs]
+    B --> C[Material Theme]
+

mkdocs.yml

@@ -0,0 +1,102 @@
+site_name: My site
+site_url: https://mydomain.org/mysite
+
+repo_name: squidfunk/mkdocs-material
+repo_url: https://github.com/squidfunk/mkdocs-material
+
+theme:
+  name: material
+  logo: assets/logo.png
+  favicon: images/favicon.png
+
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.tracking
+    - navigation.path
+    - navigation.top
+    - navigation.footer
+    - search.highlight
+    - search.suggest
+    - search.share
+    - content.code.copy
+    - content.code.annotate
+
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+
+plugins:
+  - search
+
+extra:
+  social:
+    - icon: fontawesome/brands/mastodon
+      link: https://fosstodon.org/@squidfunk
+
+  consent:
+    title: Cookie consent
+    description: >-
+      We use cookies to recognize your repeated visits and preferences, as well
+      as to measure the effectiveness of our documentation.
+
+  analytics:
+    provider: google
+    property: G-XXXXXXXXXX
+
+    feedback:
+      title: Was this page helpful?
+      ratings:
+        - icon: material/emoticon-happy-outline
+          name: This page was helpful
+          data: 1
+          note: Thanks for your feedback!
+
+        - icon: material/emoticon-sad-outline
+          name: This page could be improved
+          data: 0
+          note: >-
+            Thanks for your feedback! Help us improve this page using our
+            <a href="..." target="_blank" rel="noopener">feedback form</a>.
+
+markdown_extensions:
+  - attr_list
+  - tables
+  - md_in_html
+
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.blocks.caption
+
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+
+  - pymdownx.tabbed:
+      alternate_style: true
+
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format