Skip to content

Commit cbf93b5

Browse files
ez-pluginsez-plugins
authored
Merge pull request #23 from EzFramework/docs/public-documentation
docs: added public Markdown documentation through Github Pages
2 parents f30e892 + 246eef5 commit cbf93b5

17 files changed

Lines changed: 2132 additions & 0 deletions

‎.github/workflows/docs.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Documentation
2+
3+
on:
4+
release:
5+
types: [published]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build-and-deploy:
19+
name: Build and Deploy
20+
runs-on: ubuntu-latest
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
28+
- name: Setup Pages
29+
uses: actions/configure-pages@v5
30+
31+
- name: Build with Jekyll
32+
uses: actions/jekyll-build-pages@v1
33+
with:
34+
source: ./docs
35+
destination: ./_site
36+
37+
- name: Upload artifact
38+
uses: actions/upload-pages-artifact@v3
39+
40+
- name: Deploy to GitHub Pages
41+
id: deployment
42+
uses: actions/deploy-pages@v4

‎.github/workflows/lint.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Lint
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "docs/**/*.md"
7+
- ".markdownlint.yml"
8+
9+
jobs:
10+
markdown:
11+
name: Validate Markdown
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
17+
- name: Lint Markdown
18+
uses: DavidAnson/markdownlint-cli2-action@v16
19+
with:
20+
globs: "docs/**/*.md"
21+
config: ".markdownlint.yml"

‎.markdownlint.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
default: true
2+
MD013: false
3+
MD022: false
4+
MD025:
5+
front_matter_title: ""
6+
MD033: false
7+
MD036: false
8+
MD041: false
9+
MD024:
10+
siblings_only: true
11+
MD007:
12+
indent: 2

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# JavaQueryBuilder
22

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

59
## Features

‎docs/Gemfile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
source "https://rubygems.org"
2+
3+
gem "github-pages", group: :jekyll_plugins
4+
gem "just-the-docs"

‎docs/_config.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
title: JavaQueryBuilder
2+
description: >-
3+
A lightweight, fluent Java library for building parameterized SQL queries
4+
and filtering in-memory data. No runtime dependencies required.
5+
6+
url: "https://ezframework.github.io"
7+
baseurl: "/JavaQueryBuilder"
8+
9+
# ── Appearance ────────────────────────────────────────────────────────────────
10+
color_scheme: javaquerybuilder
11+
heading_anchors: true
12+
13+
# ── Header links ──────────────────────────────────────────────────────────────
14+
aux_links:
15+
"GitHub":
16+
- "https://github.com/EzFramework/JavaQueryBuilder"
17+
"JitPack":
18+
- "https://jitpack.io/#EzFramework/JavaQueryBuilder"
19+
20+
aux_links_new_tab: true
21+
22+
# ── Navigation ────────────────────────────────────────────────────────────────
23+
nav_sort: case_insensitive
24+
nav_external_links:
25+
- title: Changelog
26+
url: "https://github.com/EzFramework/JavaQueryBuilder/releases"
27+
hide_icon: false
28+
29+
# ── Search ────────────────────────────────────────────────────────────────────
30+
search_enabled: true
31+
search:
32+
heading_level: 2
33+
previews: 3
34+
preview_words_before: 5
35+
preview_words_after: 10
36+
tokenizer_separator: /[\s/]+/
37+
38+
# ── Footer ────────────────────────────────────────────────────────────────────
39+
back_to_top: true
40+
back_to_top_text: "Back to top"
41+
42+
footer_content: >-
43+
Copyright © 2024–2026 Gyvex.
44+
Distributed under the
45+
<a href="https://github.com/EzFramework/JavaQueryBuilder/blob/main/LICENSE">MIT License</a>.
46+
47+
# ── Kramdown ──────────────────────────────────────────────────────────────────
48+
kramdown:
49+
syntax_highlighter_opts:
50+
block:
51+
line_numbers: false
52+
53+
# ── Plugins ───────────────────────────────────────────────────────────────────
54+
plugins:
55+
- jekyll-remote-theme
56+
- jekyll-seo-tag
57+
58+
# ── Build exclusions ──────────────────────────────────────────────────────────
59+
exclude:
60+
- Gemfile
61+
- Gemfile.lock
62+
63+
remote_theme: just-the-docs/just-the-docs

‎docs/_sass/color_schemes/javaquerybuilder.scss‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// JavaQueryBuilder — dark/blue/white color scheme for just-the-docs
2+
//
3+
// Palette:
4+
// Background #141414 (body)
5+
// Surface #1c1c1c (sidebar, cards)
6+
// Elevated #222222 (code blocks, search, table rows)
7+
// Border #2e2e2e
8+
// Text #d0d0d0 (body) / #ffffff (headings)
9+
// Accent #4d9de0 (blue — links, nav highlight, buttons)
10+
// Accent dim #3a7bbf (hover state)
11+
12+
$color-scheme: dark;
13+
14+
// ── Surfaces ─────────────────────────────────────────────────────────────────
15+
$body-background-color: #141414;
16+
$sidebar-color: #1c1c1c;
17+
$feedback-color: #181818;
18+
19+
// ── Typography ────────────────────────────────────────────────────────────────
20+
$body-text-color: #d0d0d0;
21+
$body-heading-color: #ffffff;
22+
23+
// ── Links & accent ───────────────────────────────────────────────────────────
24+
$link-color: #4d9de0;
25+
$btn-primary-color: #4d9de0;
26+
27+
// ── Borders ───────────────────────────────────────────────────────────────────
28+
$border-color: #2e2e2e;
29+
30+
// ── Code ──────────────────────────────────────────────────────────────────────
31+
$code-background-color: #222222;
32+
33+
// ── Tables ────────────────────────────────────────────────────────────────────
34+
$table-background-color: #1a1a1a;
35+
36+
// ── Search ────────────────────────────────────────────────────────────────────
37+
$search-background-color: #222222;
38+
$search-foreground-color: #c0c0c0;
39+
$search-border-color: #333333;
40+
41+
// ── Buttons ───────────────────────────────────────────────────────────────────
42+
$base-button-color: #252525;

0 commit comments

Comments
 (0)