doc: Add comprehensive documentation for ComputeKit

Author: Ghassen-Lassoued

.github/workflows/docs.yml

@@ -0,0 +1,45 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./_site
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -13,7 +13,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue)](https://www.typescriptlang.org/)
 
-[Getting Started](#-getting-started) • [Examples](#-examples) • [API](#-api) • [React Hooks](#-react-hooks) • [WASM](#-webassembly-support)
+[📚 Documentation](https://tapava.github.io/compute-kit) • [Getting Started](#-getting-started) • [Examples](#-examples) • [API](#-api) • [React Hooks](#-react-hooks) • [WASM](#-webassembly-support)
 
 </div>
 
@@ -542,8 +542,8 @@ Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md)
 
 ```bash
 # Clone the repo
-git clone https://github.com/your-username/computekit.git
-cd computekit
+git clone https://github.com/tapava/compute-kit.git
+cd compute-kit
 
 # Install dependencies
 npm install
@@ -571,6 +571,7 @@ MIT © [Ghassen Lassoued](https://github.com/tapava)
     <sub>Built with ❤️ for the web platform</sub>
   </p>
   <p>
-    <a href="https://github.com/your-username/computekit">⭐ Star on GitHub</a>
+    <a href="https://tapava.github.io/compute-kit">📚 Read the Docs</a> •
+    <a href="https://github.com/tapava/compute-kit">⭐ Star on GitHub</a>
   </p>
 </div>

docs/.gitignore

@@ -0,0 +1,6 @@
+# Ignore Jekyll build output
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+vendor/

docs/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.3"
+gem "just-the-docs", "~> 0.8"
+gem "jekyll-seo-tag"
+gem "jekyll-include-cache"

docs/_config.yml

@@ -0,0 +1,67 @@
+title: ComputeKit
+description: The React-first toolkit for WASM and Web Workers
+url: 'https://tapava.github.io'
+baseurl: '/compute-kit'
+
+remote_theme: just-the-docs/just-the-docs@v0.8.2
+
+color_scheme: dark
+
+logo: '/assets/logo.svg'
+
+aux_links:
+  GitHub: https://github.com/tapava/compute-kit
+  npm: https://www.npmjs.com/package/@computekit/core
+
+aux_links_new_tab: true
+
+heading_anchors: true
+
+search_enabled: true
+search:
+  heading_level: 2
+  previews: 3
+  preview_words_before: 5
+  preview_words_after: 10
+  tokenizer_separator: /[\s/]+/
+  rel_url: true
+  button: false
+
+nav_enabled: true
+nav_sort: case_insensitive
+
+back_to_top: true
+back_to_top_text: 'Back to top'
+
+footer_content: 'Copyright © 2024-2025 Ghassen Lassoued. Distributed under the MIT license.'
+
+ga_tracking:
+ga_tracking_anonymize_ip: true
+
+callouts:
+  warning:
+    title: Warning
+    color: yellow
+  note:
+    title: Note
+    color: blue
+  tip:
+    title: Tip
+    color: green
+
+plugins:
+  - jekyll-seo-tag
+  - jekyll-include-cache
+
+kramdown:
+  syntax_highlighter_opts:
+    block:
+      line_numbers: false
+
+compress_html:
+  clippings: all
+  comments: all
+  endings: all
+  startings: []
+  blanklines: false
+  profile: false