@life-exe/wiki-engine 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yuri Popov (life-exe)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,180 @@
+# @life-exe/wiki-engine
+
+Modern, high-performance documentation and wiki engine built with React, Vite, and Tailwind CSS.
+
+Features:
+- 📖 **Markdown & GFM Support**: Headings, tables, blockquotes, task lists, and custom callouts (`hint`, `warning`, `error`, `good`).
+- 🌐 **Multilingual (RU / EN / Custom)**: Switch languages with persistent state and automatic fallback banners when a translation is missing.
+- 🎨 **Dark / Light Theme**: Built-in theme switcher with system preference detection and localStorage persistence.
+- 🔍 **Full-text Search (Ctrl+K)**: Instant snippet search across all sections and lectures with keyboard navigation.
+- ↔️ **Resizable Sidebar**: Draggable width resizer with collapse/expand all and smooth collapse animation.
+- 💻 **Syntax Highlighting & Copy**: Highlight.js integration with language badge, one-click code copying, and customizable language definitions (including Unreal Engine C++).
+- 📊 **Mermaid Diagrams**: Interactive rendering of flowcharts, sequence diagrams, state machines, etc.
+- 🔍 **Zoomable Images**: Click to zoom lightbox for screenshots and diagrams.
+- 🔗 **Doc Link Cards**: Automatic rich preview cards for documentation links with caching.
+- 🍪 **Cookie Consent & Analytics**: Built-in Google Analytics 4 integration with Google Consent Mode v2 and customizable privacy banner.
+
+---
+
+## Installation
+
+```bash
+# Using pnpm
+pnpm add @life-exe/wiki-engine
+
+# Using npm
+npm install @life-exe/wiki-engine
+
+# Directly from GitHub repository
+pnpm add github:life-exe/UECppProWiki#master
+```
+
+### Peer Dependencies
+Ensure you have the following installed in your project:
+```json
+{
+  "dependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "react-router-dom": ">=6.0.0"
+  }
+}
+```
+
+---
+
+## Quick Start (New Project)
+
+### 1. Structure your documentation folder
+
+```
+my-project/
+├── docs/
+│   ├── ru/
+│   │   ├── README.md              # Home page (RU)
+│   │   ├── 01-intro.md            # Section (RU)
+│   │   └── 01-intro/
+│   │       └── 01-getting-started.md  # Sub-page/lecture (RU)
+│   └── en/
+│       ├── README.md              # Home page (EN)
+│       ├── 01-intro.md            # Section (EN)
+│       └── 01-intro/
+│           └── 01-getting-started.md  # Sub-page/lecture (EN)
+├── src/
+│   ├── App.tsx
+│   ├── wiki.config.tsx
+│   ├── wikiData.ts
+│   └── main.tsx
+```
+
+### 2. Prepare data loader (`src/wikiData.ts`)
+
+```ts
+import { createWikiData } from "@life-exe/wiki-engine";
+
+export const wikiData = createWikiData({
+  sectionsRu: import.meta.glob("../docs/ru/*.md", { query: "?raw", import: "default", eager: true }),
+  sectionsEn: import.meta.glob("../docs/en/*.md", { query: "?raw", import: "default", eager: true }),
+  lecturesRu: import.meta.glob("../docs/ru/*/*.md", { query: "?raw", import: "default", eager: true }),
+  lecturesEn: import.meta.glob("../docs/en/*/*.md", { query: "?raw", import: "default", eager: true }),
+  images: import.meta.glob("../docs/**/*.{png,jpg,jpeg,gif,svg}", { import: "default", eager: true }),
+});
+```
+
+### 3. Create configuration (`src/wiki.config.tsx`)
+
+```tsx
+import { defineWikiConfig } from "@life-exe/wiki-engine";
+
+export const wikiConfig = defineWikiConfig({
+  brand: {
+    title: {
+      ru: "Моя База Знаний",
+      en: "My Knowledge Base",
+    },
+    homeLink: "/",
+  },
+  defaultLanguage: "ru",
+  supportedLanguages: ["ru", "en"],
+  categories: [
+    { id: "intro", label: { ru: "Введение", en: "Intro" }, from: "01", to: "01" },
+    { id: "guides", label: { ru: "Руководства", en: "Guides" }, from: "02", to: "99" },
+  ],
+  cookieConsent: {
+    enabled: true,
+    privacyPolicyUrl: "/privacy",
+  },
+});
+```
+
+### 4. Render the App (`src/App.tsx`)
+
+```tsx
+import { WikiApp } from "@life-exe/wiki-engine";
+import "@life-exe/wiki-engine/style.css";
+import { wikiConfig } from "./wiki.config";
+import { wikiData } from "./wikiData";
+
+export default function App() {
+  return <WikiApp config={wikiConfig} data={wikiData} />;
+}
+```
+
+---
+
+## Configuration API (`WikiConfig`)
+
+| Option | Type | Description |
+|---|---|---|
+| `brand.title` | `string \| { ru?: string, en?: string } \| ReactNode` | Sidebar header title |
+| `brand.logo` | `ReactNode` | Optional logo icon or image |
+| `brand.homeLink` | `string` | Link on title click (default: `"/"`) |
+| `defaultLanguage` | `string` | Initial language code (default: `"ru"`) |
+| `supportedLanguages`| `string[]` | Array of languages (e.g. `["ru", "en"]` or `["en"]`). If length <= 1, language toggle is hidden |
+| `categories` | `WikiCategoryConfig[]` | Groupings for sidebar navigation |
+| `syntaxLanguages` | `Record<string, any>` | Custom highlight.js languages for lowlight / code blocks |
+| `customComponents` | `Record<string, ComponentType>` | Custom React components usable in markdown (e.g. `<community-links />`) |
+| `analytics` | `{ googleAnalyticsId?: string, linkerDomains?: string[] }` | Google Analytics 4 tracking |
+| `cookieConsent` | `{ enabled?: boolean, privacyPolicyUrl?: string }` | Cookie consent popup |
+| `enableSearch` | `boolean` | Enable or disable Ctrl+K search (default: `true`) |
+| `enableThemeToggle` | `boolean` | Enable or disable Dark/Light theme button (default: `true`) |
+
+---
+
+## Category Matching
+
+Categories can group sections in the sidebar in multiple ways:
+
+```ts
+categories: [
+  // 1. By numeric prefix range (e.g. 01-about.md to 05-basics.md)
+  { label: "Basics", from: "01", to: "05" },
+
+  // 2. By regex pattern
+  { label: "Advanced", pattern: /^adv-/ },
+
+  // 3. By custom filter function
+  { label: "Special", filter: (page) => page.slug.includes("special") }
+]
+```
+
+---
+
+## Unreal Engine C++ Support
+
+To use Unreal Engine C++ keyword and type highlighting:
+
+```ts
+import { ueLangs } from "@life-exe/wiki-engine/languages/ue-cpp";
+
+export const wikiConfig = defineWikiConfig({
+  // ...
+  syntaxLanguages: ueLangs,
+});
+```
+
+---
+
+## License
+
+MIT

package/dist/analytics/index.d.ts

@@ -0,0 +1,10 @@
+declare global {
+    interface Window {
+        dataLayer?: unknown[];
+        gtag?: (...args: unknown[]) => void;
+    }
+}
+export declare const initGA: (measurementId?: string, linkerDomains?: string[]) => void;
+export declare const updateConsentState: (granted: boolean) => void;
+export declare const trackPageView: (path: string, title?: string) => void;
+export declare function AnalyticsTracker(): null;

package/dist/chunks/abnfDiagram-VCTEODGH-DyAP6Aua.js

@@ -0,0 +1,87 @@
+import { g as p, r as u, d as a } from "./chunk-SVP7TREG-DN-ravNt.js";
+import { p as f } from "./chunk-JWPE2WC7-BIokdAUW.js";
+import { _ as n, l as o } from "./index-f7Uzykhj.js";
+import { M as c, b as d } from "./cynefin-OW5HDTMX-Bzjecpt-.js";
+var v = d().RailroadAbnf.parser.LangiumParser, l = /* @__PURE__ */ n((e) => {
+  const r = e.alternatives.map(g);
+  return r.length === 1 ? r[0] : {
+    type: "choice",
+    alternatives: r
+  };
+}, "transformAlternation"), g = /* @__PURE__ */ n((e) => {
+  const r = e.elements.map(y);
+  return r.length === 1 ? r[0] : {
+    type: "sequence",
+    elements: r
+  };
+}, "transformConcatenation"), b = /* @__PURE__ */ n((e) => {
+  if (e.includes("*")) {
+    const [t, s] = e.split("*"), i = t ? parseInt(t, 10) : 0, m = s ? parseInt(s, 10) : 1 / 0;
+    return { min: i, max: m };
+  }
+  const r = parseInt(e, 10);
+  return { min: r, max: r };
+}, "parseRepeat"), y = /* @__PURE__ */ n((e) => {
+  const r = A(e.primary);
+  if (!e.repeat)
+    return r;
+  const { min: t, max: s } = b(e.repeat);
+  return t === 0 && s === 1 ? { type: "optional", element: r } : {
+    type: "repetition",
+    element: r,
+    min: t,
+    max: s
+  };
+}, "transformElement"), A = /* @__PURE__ */ n((e) => {
+  switch (e.$type) {
+    case "AbnfStringLiteral":
+      return {
+        type: "terminal",
+        value: e.value
+      };
+    case "AbnfNumVal":
+      return {
+        type: "terminal",
+        value: e.value
+      };
+    case "AbnfRuleName":
+      return {
+        type: "nonterminal",
+        name: e.name
+      };
+    case "AbnfGroup":
+      return l(e.element);
+    case "AbnfOptionalGroup":
+      return {
+        type: "optional",
+        element: l(e.element)
+      };
+    default:
+      throw new Error(`Unsupported ABNF primary node: ${e.$type}`);
+  }
+}, "transformPrimary"), P = /* @__PURE__ */ n((e) => ({
+  name: e.name,
+  definition: l(e.definition)
+}), "transformRule"), h = /* @__PURE__ */ n((e) => {
+  f(e, a), e.title && a.setTitle(e.title), e.rules.map((r) => a.addRule(P(r)));
+}, "populateDb"), R = {
+  parse: /* @__PURE__ */ n((e) => {
+    a.clear(), o.debug("[ABNF Parser] Starting Langium parse");
+    const r = v.parse(e);
+    if (r.lexerErrors.length > 0 || r.parserErrors.length > 0)
+      throw new c(r);
+    const t = r.value;
+    o.debug("[ABNF Parser] Parsed rules:", t.rules.length), h(t), o.debug("[ABNF Parser] Parse complete");
+  }, "parse"),
+  parser: {
+    yy: a
+  }
+}, w = {
+  parser: R,
+  db: a,
+  renderer: u,
+  styles: p
+};
+export {
+  w as diagram
+};

package/dist/chunks/arc-OroUeRL_.js

@@ -0,0 +1,83 @@
+import { a3 as ln, a4 as an, a5 as g, a6 as tn, a7 as H, a8 as q, a9 as _, aa as un, ab as rn, ac as L, ad as o, ae as B, af as sn, ag as on, ah as fn } from "./index-f7Uzykhj.js";
+function cn(l) {
+  return l.innerRadius;
+}
+function gn(l) {
+  return l.outerRadius;
+}
+function yn(l) {
+  return l.startAngle;
+}
+function dn(l) {
+  return l.endAngle;
+}
+function mn(l) {
+  return l && l.padAngle;
+}
+function pn(l, h, I, D, v, A, C, a) {
+  var O = I - l, i = D - h, n = C - v, d = a - A, u = d * O - n * i;
+  if (!(u * u < g))
+    return u = (n * (h - A) - d * (l - v)) / u, [l + u * O, h + u * i];
+}
+function W(l, h, I, D, v, A, C) {
+  var a = l - I, O = h - D, i = (C ? A : -A) / L(a * a + O * O), n = i * O, d = -i * a, u = l + n, s = h + d, f = I + n, c = D + d, F = (u + f) / 2, t = (s + c) / 2, m = f - u, y = c - s, R = m * m + y * y, T = v - A, P = u * c - f * s, S = (y < 0 ? -1 : 1) * L(fn(0, T * T * R - P * P)), j = (P * y - m * S) / R, z = (-P * m - y * S) / R, w = (P * y + m * S) / R, p = (-P * m + y * S) / R, x = j - F, e = z - t, r = w - F, G = p - t;
+  return x * x + e * e > r * r + G * G && (j = w, z = p), {
+    cx: j,
+    cy: z,
+    x01: -n,
+    y01: -d,
+    x11: j * (v / T - 1),
+    y11: z * (v / T - 1)
+  };
+}
+function hn() {
+  var l = cn, h = gn, I = B(0), D = null, v = yn, A = dn, C = mn, a = null, O = ln(i);
+  function i() {
+    var n, d, u = +l.apply(this, arguments), s = +h.apply(this, arguments), f = v.apply(this, arguments) - an, c = A.apply(this, arguments) - an, F = un(c - f), t = c > f;
+    if (a || (a = n = O()), s < u && (d = s, s = u, u = d), !(s > g)) a.moveTo(0, 0);
+    else if (F > tn - g)
+      a.moveTo(s * H(f), s * q(f)), a.arc(0, 0, s, f, c, !t), u > g && (a.moveTo(u * H(c), u * q(c)), a.arc(0, 0, u, c, f, t));
+    else {
+      var m = f, y = c, R = f, T = c, P = F, S = F, j = C.apply(this, arguments) / 2, z = j > g && (D ? +D.apply(this, arguments) : L(u * u + s * s)), w = _(un(s - u) / 2, +I.apply(this, arguments)), p = w, x = w, e, r;
+      if (z > g) {
+        var G = sn(z / u * q(j)), M = sn(z / s * q(j));
+        (P -= G * 2) > g ? (G *= t ? 1 : -1, R += G, T -= G) : (P = 0, R = T = (f + c) / 2), (S -= M * 2) > g ? (M *= t ? 1 : -1, m += M, y -= M) : (S = 0, m = y = (f + c) / 2);
+      }
+      var J = s * H(m), K = s * q(m), N = u * H(T), Q = u * q(T);
+      if (w > g) {
+        var U = s * H(y), V = s * q(y), X = u * H(R), Y = u * q(R), E;
+        if (F < rn)
+          if (E = pn(J, K, X, Y, U, V, N, Q)) {
+            var Z = J - E[0], $ = K - E[1], b = U - E[0], k = V - E[1], nn = 1 / q(on((Z * b + $ * k) / (L(Z * Z + $ * $) * L(b * b + k * k))) / 2), en = L(E[0] * E[0] + E[1] * E[1]);
+            p = _(w, (u - en) / (nn - 1)), x = _(w, (s - en) / (nn + 1));
+          } else
+            p = x = 0;
+      }
+      S > g ? x > g ? (e = W(X, Y, J, K, s, x, t), r = W(U, V, N, Q, s, x, t), a.moveTo(e.cx + e.x01, e.cy + e.y01), x < w ? a.arc(e.cx, e.cy, x, o(e.y01, e.x01), o(r.y01, r.x01), !t) : (a.arc(e.cx, e.cy, x, o(e.y01, e.x01), o(e.y11, e.x11), !t), a.arc(0, 0, s, o(e.cy + e.y11, e.cx + e.x11), o(r.cy + r.y11, r.cx + r.x11), !t), a.arc(r.cx, r.cy, x, o(r.y11, r.x11), o(r.y01, r.x01), !t))) : (a.moveTo(J, K), a.arc(0, 0, s, m, y, !t)) : a.moveTo(J, K), !(u > g) || !(P > g) ? a.lineTo(N, Q) : p > g ? (e = W(N, Q, U, V, u, -p, t), r = W(J, K, X, Y, u, -p, t), a.lineTo(e.cx + e.x01, e.cy + e.y01), p < w ? a.arc(e.cx, e.cy, p, o(e.y01, e.x01), o(r.y01, r.x01), !t) : (a.arc(e.cx, e.cy, p, o(e.y01, e.x01), o(e.y11, e.x11), !t), a.arc(0, 0, u, o(e.cy + e.y11, e.cx + e.x11), o(r.cy + r.y11, r.cx + r.x11), t), a.arc(r.cx, r.cy, p, o(r.y11, r.x11), o(r.y01, r.x01), !t))) : a.arc(0, 0, u, T, R, t);
+    }
+    if (a.closePath(), n) return a = null, n + "" || null;
+  }
+  return i.centroid = function() {
+    var n = (+l.apply(this, arguments) + +h.apply(this, arguments)) / 2, d = (+v.apply(this, arguments) + +A.apply(this, arguments)) / 2 - rn / 2;
+    return [H(d) * n, q(d) * n];
+  }, i.innerRadius = function(n) {
+    return arguments.length ? (l = typeof n == "function" ? n : B(+n), i) : l;
+  }, i.outerRadius = function(n) {
+    return arguments.length ? (h = typeof n == "function" ? n : B(+n), i) : h;
+  }, i.cornerRadius = function(n) {
+    return arguments.length ? (I = typeof n == "function" ? n : B(+n), i) : I;
+  }, i.padRadius = function(n) {
+    return arguments.length ? (D = n == null ? null : typeof n == "function" ? n : B(+n), i) : D;
+  }, i.startAngle = function(n) {
+    return arguments.length ? (v = typeof n == "function" ? n : B(+n), i) : v;
+  }, i.endAngle = function(n) {
+    return arguments.length ? (A = typeof n == "function" ? n : B(+n), i) : A;
+  }, i.padAngle = function(n) {
+    return arguments.length ? (C = typeof n == "function" ? n : B(+n), i) : C;
+  }, i.context = function(n) {
+    return arguments.length ? (a = n ?? null, i) : a;
+  }, i;
+}
+export {
+  hn as d
+};