feat: Implement material for mkdocs functionality with basic introduction

.github/workflows/semantic_pr_title.yaml

@@ -11,7 +11,7 @@ jobs:
       pull-requests: read
     steps:
       - name: Check PR title uses conventional commit spec
-        uses: amannn/action-semantic-pull-request@latest
+        uses: amannn/action-semantic-pull-request@v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.gitignore

@@ -1 +1,2 @@
 .venv
+.cache

docs/blog/.authors.yml

@@ -0,0 +1,5 @@
+authors:
+  samiralavi:
+    name: Seyed Amir Alavi
+    description: Creator
+    avatar: https://github.com/samiralavi.png

docs/blogs/index.md

@@ -0,0 +1,2 @@
+# Blog
+

docs/index.md

@@ -1 +1,95 @@
-# EmbedIDS, Modern Intrusion Detection System (IDS) for Embedded Systems
+---
+title: Home 
+description: EmbedIDS is a lightweight Runtime Intrusion Detection SDK specifically designed for low-power embedded Internet of Things (IoT) devices. Our open-source SDK provides AI-driven protection to address the critical security gap in constrained IoT environments.
+hide:
+  - toc
+---
+# EmbedIDS: Open Source Intrusion Detection System (IDS) for Embedded Systems
+
+![EmbedIDS Logo](images/embedIDS_logo_text.png)
+
+EmbedIDS is a lightweight Runtime Intrusion Detection SDK specifically designed for low-power embedded Internet of Things (IoT) devices. Our open-source SDK provides AI-driven protection to address the critical security gap in constrained IoT environments.
+
+## Overview
+
+EmbedIDS provides on-device, AI-driven protection tailored to resource-constrained embedded systems. By deploying compact anomaly-detection agents directly on devices, we enable real-time protection without relying on external connectivity or cloud dependencies.
+
+## Product Features
+
+### Open-Source SDK (Apache 2.0 Licensed)
+Our free SDK empowers developers to secure embedded devices at no cost, featuring:
+
+- **Lightweight on-device intrusion detection system**
+- **Fixed-logic detection models** optimized for low-power environments
+- **Zero licensing fees** for developers and deployments
+- **Apache 2.0 license** ensuring maximum flexibility and adoption
+- **Customizable metric collection** for device-specific monitoring
+- **AI-model training tools** for tailored threat detection
+
+## Key Features
+
+### On-Device Intelligence
+- **Real-time anomaly detection** without cloud dependency
+- **Compact ML models** optimized for embedded constraints
+- **Behavioral analysis** tailored to device-specific operations
+- **Low resource footprint** suitable for IoT devices
+
+### Customizable Security
+- **Define custom behavioral metrics** based on device functionality
+- **Train specialized ML models** using our development tools
+- **Deploy targeted protection** for specific threat vectors
+- **Adaptive monitoring** that evolves with device behavior
+
+### Developer-Friendly Design
+- **Easy integration** with existing embedded systems
+- **Minimal configuration** required for basic protection
+- **Comprehensive documentation** and examples
+- **Active community support** for open-source users
+
+## Why EmbedIDS?
+
+The IoT security landscape faces unique challenges:
+
+- **Resource constraints** limit traditional security solutions
+- **Connectivity issues** make cloud-dependent protection unreliable
+- **Scale requirements** demand cost-effective deployment models
+- **Diverse hardware** needs flexible, adaptable solutions
+
+EmbedIDS addresses these challenges by providing:
+
+1. **On-device protection** that works offline
+2. **Lightweight implementation** suitable for constrained devices
+3. **Open-source model** enabling rapid adoption and community collaboration
+4. **AI-driven detection** for sophisticated threat identification
+
+## Getting Started
+
+Start securing your embedded devices immediately with our open-source SDK:
+
+1. Download the SDK from our repository
+2. Integrate the lightweight SDK into your device
+3. Configure intrusion detection rules for your use case
+4. Train custom ML models using our development tools
+5. Deploy with confidence knowing your devices are protected
+
+## Use Cases
+
+- **Industrial IoT sensors** monitoring critical infrastructure
+- **Smart home devices** protecting personal networks
+- **Medical IoT devices** ensuring patient safety and privacy
+- **Automotive embedded systems** securing connected vehicles
+- **Edge computing nodes** protecting distributed networks
+
+## Community and Support
+
+EmbedIDS thrives on open-source collaboration and community contribution:
+
+- **Active open-source community** for developers and researchers
+- **Community support** through forums and documentation
+- **Regular updates** and security patches
+- **Comprehensive documentation** and tutorials for all skill levels
+- **Contribution guidelines** for community developers
+
+---
+
+*Ready to secure your embedded devices? Download our open-source SDK and join the community!*

docs/overrides/main.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %}
+
+{% block announce %}
+  <!-- Add announcement here, including arbitrary HTML -->
+   EmbedIDS is launching soon! Stay tuned for updates. Follow us on <a href="https://www.linkedin.com/company/embedids">LinkedIn</a> for the latest news.
+{% endblock %}

mkdocs.yml

@@ -1,34 +1,48 @@
-site_name: EmbedIDS, Modern Intrusion Detection System (IDS) for Embedded Systems
+site_name: EmbedIDS, Cybersecurity for Embedded Systems 
 site_author: Seyed Amir Alavi
-site_url: https://embedids.samiralavi.io/
-repo_name: samiralavi/embedids
+site_url: https://embedids.samiralavi.io/ 
+repo_url: https://github.com/samiralavi/embedids
 docs_dir: "docs"
 theme:
   name: material
+  custom_dir: docs/overrides
   language: en
-  icon:
-    logo: material/contacts
+  logo: images/embedIDS_logo.png
   favicon: images/favicon.png
+  icon:
+    repo: fontawesome/brands/github
   palette:
+      # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    # Palette toggle for light mode
     - media: "(prefers-color-scheme: light)"
       scheme: default
       toggle:
         icon: material/weather-sunny
         name: Switch to dark mode
-      primary: teal
-      accent: blue
+      primary: white
+      accent: red
+    # Palette toggle for dark mode
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
       toggle:
         icon: material/weather-night
         name: Switch to light mode
-      primary: teal
+      primary: red
       accent: red
 
   features:
     - navigation.sections
-    - toc.integrate
+    - navigation.tabs
+    - navigation.sections
     - navigation.top
+    - navigation.footer
+    - header.autohide
+    - toc.integrate
+    - toc.follow
     - search.suggest
     - search.highlight
     - search.share
@@ -37,6 +51,35 @@ theme:
 extra:
   version:
     provider: mike
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/samiralavi/embedids
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/embedids
+  analytics:
+    provider: google
+    property: G-5ZPJDQ0248
+    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 by
+            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
+  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 and whether users
+      find what they're searching for. With your consent, you're helping us to
+      make our documentation better.
 
 markdown_extensions:
   - admonition
@@ -57,8 +100,32 @@ markdown_extensions:
 plugins:
   - search
   - mike
-
+  - social
+  - blog:
+      blog_dir: blog
+      archive: false
+  - rss:
+      match_path: blog/posts/.* 
+      date_from_meta:
+        as_creation: date
+      categories:
+        - categories
+        - tags
+  - git-revision-date-localized:
+      enable_creation_date: true
+  - git-committers:
+      repository: samiralavi/embedids
+      branch: main
 nav:
   - "index.md"
+  - Blog:
+    - blog/index.md
+
+extra_css:
+  - stylesheets/extra.css
+
+extra_javascript:
+  - javascripts/extra.js
 
-copyright: Copyright &copy; 2025 Seyed Amir Alavi.
+copyright: Copyright &copy; 2025 Seyed Amir Alavi and Mahyar Abbaspour –
+  <a href="#__consent">Change cookie settings</a>