jchunk-io · PabloSanchi · Oct 28, 2025 · Oct 28, 2025 · Oct 28, 2025 · Oct 28, 2025
@@ -0,0 +1,54 @@
+name: Deploy Antora to GitHub Pages
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'antora-playbook.yml'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build Antora site
+        run: |
+          npx -y -p @antora/cli@3.1 -p @antora/site-generator@3.1 antora -r @antora/site-generator antora-playbook.yml
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build/site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
@@ -55,6 +55,23 @@ To check javadocs using the javadoc:javadoc
 ./mvnw javadoc:javadoc -Pjavadoc
 ```
 
+## Building the docs locally
+
+You can build and preview the Antora documentation locally without installing anything globally.
+
+Prerequisites:
+- Node.js 18+ (20 recommended). 
+  - Download from https://nodejs.org/
+
+Build the site:
+
+```sh
+npx -y -p @antora/cli@3.1 -p @antora/site-generator@3.1 antora -r @antora/site-generator antora-playbook.yml
+```
+
+Open the generated site:
+- `build/site/index.html`
+
 ## Contributing
 
 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
@@ -0,0 +1,25 @@
+site:
+  title: JChunk Docs
+  start_page: jchunk::index.adoc
+
+content:
+  sources:
+    - url: .
+      start_path: docs
+      branches: HEAD
+
+ui:
+  bundle:
+    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
+    snapshot: false
+  supplemental_files: docs/ui
+
+asciidoc:
+  attributes:
+    page-pagination: ''
+
+runtime:
+  fetch: true
+
+output:
+  dir: build/site
@@ -1,4 +1,4 @@
-name: Jchunk
+name: jchunk
 version:
   v(?<version>+({0..9}).+({0..9}).+({0..9})): $<version>
   early-access: snapshot

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  {{> head}}
+</head>
+<body>
+  <header class="navbar" role="banner">
+    <div class="container">
+      {{> header-content}}
+    </div>
+  </header>
+
+  <main id="content" class="container" role="main">
+    {{#if page.title}}
+      <h1 class="page-title">{{page.title}}</h1>
+    {{/if}}
+    <article class="doc">
+      {{{page.contents}}}
+    </article>
+  </main>
+
+  <footer class="footer" role="contentinfo">
+    <div class="container">
+      {{> footer-content}}
+    </div>
+  </footer>
+</body>
+</html>
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  {{> head}}
+</head>
+<body>
+  <header class="navbar" role="banner">
+    <div class="container">
+      {{> header-content}}
+    </div>
+  </header>
+
+  <main id="content" class="container" role="main">
+    {{#if page.title}}
+      <h1 class="page-title">{{page.title}}</h1>
+    {{/if}}
+    <article class="doc home">
+      {{{page.contents}}}
+    </article>
+  </main>
+
+  <footer class="footer" role="contentinfo">
+    <div class="container">
+      {{> footer-content}}
+    </div>
+  </footer>
+</body>
+</html>
@@ -0,0 +1,6 @@
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>{{#if page.title}}{{page.title}} | {{/if}}{{#if site.title}}{{site.title}}{{else}}Documentation{{/if}}</title>
+<link rel="stylesheet" href="{{uiRootPath}}/assets/styles.css">
+<script defer src="{{uiRootPath}}/assets/site.js"></script>
@@ -0,0 +1,9 @@
+<div class="nav">
+  <a class="back-btn" href="{{siteRootPath}}/" aria-label="Go back" onclick="if (history.length > 1) { history.back(); return false; }">
+    <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" viewBox="0 0 16 16" aria-hidden="true"><path d="M11 2.5a.75.75 0 0 1 0 1.06L6.56 8l4.44 4.44a.75.75 0 0 1-1.06 1.06l-5-5a.75.75 0 0 1 0-1.06l5-5a.75.75 0 0 1 1.06 0z"/></svg>
+  </a>
+  <div class="brand">
+    <a class="logo" href="{{siteRootPath}}/"></a>
+    <a class="title" href="{{siteRootPath}}/">{{#if site.title}}{{site.title}}{{else}}Documentation{{/if}}</a>
+  </div>
+</div>
@@ -1,7 +1,7 @@
 # SemanticChunker
 
 Splits text into chunks based on **semantic similarity** using embeddings.  
-Instead of relying only on character counts or delimiters, it groups sentences into coherent chunks that better preserve meaning — useful for **RAG pipelines**, **semantic search**, and **embedding-based retrieval**.
+Instead of relying only on character counts or delimiters, it groups sentences into coherent chunks that better preserve meaning, useful for **RAG pipelines**, **semantic search**, and **embedding-based retrieval**.
 
 ## Installing