docs: added public Markdown documentation through Github Pages

.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+name: Documentation
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    name: Build and Deploy
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs
+          destination: ./_site
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: Lint
+
+on:
+  pull_request:
+    paths:
+      - "docs/**/*.md"
+      - ".markdownlint.yml"
+
+jobs:
+  markdown:
+    name: Validate Markdown
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Lint Markdown
+        uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          globs: "docs/**/*.md"
+          config: ".markdownlint.yml"

.markdownlint.yml

@@ -0,0 +1,12 @@
+default: true
+MD013: false
+MD022: false
+MD025:
+  front_matter_title: ""
+MD033: false
+MD036: false
+MD041: false
+MD024:
+  siblings_only: true
+MD007:
+  indent: 2

README.md

@@ -1,5 +1,9 @@
 # JavaQueryBuilder
 
+[![JitPack](https://jitpack.io/v/EzFramework/JavaQueryBuilder.svg)](https://jitpack.io/#EzFramework/JavaQueryBuilder)
+[![GitHub Packages](https://img.shields.io/github/v/release/EzFramework/JavaQueryBuilder?label=GitHub%20Packages&logo=github)](https://github.com/EzFramework/JavaQueryBuilder/packages)
+[![codecov](https://codecov.io/gh/EzFramework/JavaQueryBuilder/branch/main/graph/badge.svg)](https://codecov.io/gh/EzFramework/JavaQueryBuilder)
+
 A lightweight, fluent Java library for building parameterized SQL queries and filtering in-memory data, no runtime dependencies required.
 
 ## Features

docs/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "github-pages", group: :jekyll_plugins
+gem "just-the-docs"

docs/_config.yml

@@ -0,0 +1,63 @@
+title: JavaQueryBuilder
+description: >-
+  A lightweight, fluent Java library for building parameterized SQL queries
+  and filtering in-memory data. No runtime dependencies required.
+
+url: "https://ezframework.github.io"
+baseurl: "/JavaQueryBuilder"
+
+# ── Appearance ────────────────────────────────────────────────────────────────
+color_scheme: javaquerybuilder
+heading_anchors: true
+
+# ── Header links ──────────────────────────────────────────────────────────────
+aux_links:
+  "GitHub":
+    - "https://github.com/EzFramework/JavaQueryBuilder"
+  "JitPack":
+    - "https://jitpack.io/#EzFramework/JavaQueryBuilder"
+
+aux_links_new_tab: true
+
+# ── Navigation ────────────────────────────────────────────────────────────────
+nav_sort: case_insensitive
+nav_external_links:
+  - title: Changelog
+    url: "https://github.com/EzFramework/JavaQueryBuilder/releases"
+    hide_icon: false
+
+# ── Search ────────────────────────────────────────────────────────────────────
+search_enabled: true
+search:
+  heading_level:        2
+  previews:             3
+  preview_words_before: 5
+  preview_words_after:  10
+  tokenizer_separator:  /[\s/]+/
+
+# ── Footer ────────────────────────────────────────────────────────────────────
+back_to_top:      true
+back_to_top_text: "Back to top"
+
+footer_content: >-
+  Copyright © 2024–2026 Gyvex.
+  Distributed under the
+  <a href="https://github.com/EzFramework/JavaQueryBuilder/blob/main/LICENSE">MIT License</a>.
+
+# ── Kramdown ──────────────────────────────────────────────────────────────────
+kramdown:
+  syntax_highlighter_opts:
+    block:
+      line_numbers: false
+
+# ── Plugins ───────────────────────────────────────────────────────────────────
+plugins:
+  - jekyll-remote-theme
+  - jekyll-seo-tag
+
+# ── Build exclusions ──────────────────────────────────────────────────────────
+exclude:
+  - Gemfile
+  - Gemfile.lock
+
+remote_theme: just-the-docs/just-the-docs

docs/_sass/color_schemes/javaquerybuilder.scss

@@ -0,0 +1,42 @@
+// JavaQueryBuilder — dark/blue/white color scheme for just-the-docs
+//
+// Palette:
+//   Background   #141414  (body)
+//   Surface      #1c1c1c  (sidebar, cards)
+//   Elevated     #222222  (code blocks, search, table rows)
+//   Border       #2e2e2e
+//   Text         #d0d0d0  (body)   /  #ffffff (headings)
+//   Accent       #4d9de0  (blue — links, nav highlight, buttons)
+//   Accent dim   #3a7bbf  (hover state)
+
+$color-scheme: dark;
+
+// ── Surfaces ─────────────────────────────────────────────────────────────────
+$body-background-color: #141414;
+$sidebar-color:         #1c1c1c;
+$feedback-color:        #181818;
+
+// ── Typography ────────────────────────────────────────────────────────────────
+$body-text-color:    #d0d0d0;
+$body-heading-color: #ffffff;
+
+// ── Links & accent ───────────────────────────────────────────────────────────
+$link-color:        #4d9de0;
+$btn-primary-color: #4d9de0;
+
+// ── Borders ───────────────────────────────────────────────────────────────────
+$border-color: #2e2e2e;
+
+// ── Code ──────────────────────────────────────────────────────────────────────
+$code-background-color: #222222;
+
+// ── Tables ────────────────────────────────────────────────────────────────────
+$table-background-color: #1a1a1a;
+
+// ── Search ────────────────────────────────────────────────────────────────────
+$search-background-color: #222222;
+$search-foreground-color:  #c0c0c0;
+$search-border-color:      #333333;
+
+// ── Buttons ───────────────────────────────────────────────────────────────────
+$base-button-color: #252525;