elseware-docs-engine 1.2.2 → 1.3.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 elseware Technology
+
+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

@@ -1,139 +1,175 @@
-# elseware Docs Engine
-
-A modern React documentation engine built for structured Markdown-based documentation websites with nested routing, sidebar generation, dark mode support, and responsive layouts.
-
-Built with:
-- React
-- TypeScript
-- Vite
-- React Router
-- elseware-ui
-- MDXEditor
-
----
-
-## Features
-
-- Nested documentation structure
-- Automatic sidebar generation
-- Responsive mobile sidebar
-- Markdown rendering
-- Code block support
-- Dark mode support
-- Customizable base path
-- TypeScript support
-- Vite powered
-- Clean documentation layouts
-
----
-
-## Installation
-
-```bash
-npm install elseware-docs-engine
-```
-
----
-
-## Import Styles
-
-```ts
-import "elseware-docs-engine/dist/index.css";
-```
-
----
-
-## Basic Usage
-
-```tsx
-import React from "react";
-
-import ReactDOM from "react-dom/client";
-
-import { DocsEngine } from "elseware-docs-engine";
-
-import docs from "./docs";
-
-import "elseware-docs-engine/dist/index.css";
-
-ReactDOM.createRoot(document.getElementById("root")!).render(
-  <React.StrictMode>
-    <DocsEngine
-      docs={docs}
-      basePath="/docs"
-    />
-  </React.StrictMode>,
-);
-```
-
----
-
-## Docs Structure Example
-
-```ts
-import intro from "./getting-started/intro.md?raw";
-
-import { DocsCategory } from "elseware-docs-engine";
-
-const docs: DocsCategory[] = [
-  {
-    title: "Getting Started",
-
-    path: "/getting-started",
-
-    children: [
-      {
-        title: "Introduction",
-
-        path: "/intro",
-
-        content: intro,
-      },
-    ],
-  },
-];
-
-export default docs;
-```
-
----
-
-## Markdown Features
-
-- Headings
-- Tables
-- Lists
-- Images
-- Links
-- Quotes
-- Code blocks
-- Syntax highlighting
-- Nested navigation
-
----
-
-## Development
-
-```bash
-npm run dev
-```
-
----
-
-## Build
-
-```bash
-npm run build
-```
-
----
-
-## License
-
-MIT License
-
----
-
-## Author
-
-elseware Technology
+# elseware Docs Engine
+
+A modern React documentation engine built for structured Markdown-based documentation websites with nested routing, sidebar generation, dark mode support, and responsive layouts.
+
+Built with:
+
+- React
+- TypeScript 7
+- Vite
+- React Router
+- elseware-ui
+- MDXEditor
+
+---
+
+## Features
+
+- Nested documentation structure
+- Automatic sidebar generation
+- Responsive mobile sidebar
+- Markdown rendering
+- Code block support
+- Dark mode support
+- Customizable base path
+- TypeScript support
+- Vite powered
+- Clean documentation layouts
+
+---
+
+## Installation
+
+```bash
+npm install elseware-docs-engine
+```
+
+---
+
+## Import Styles
+
+```ts
+import "elseware-docs-engine/dist/index.css";
+```
+
+---
+
+## Basic Usage
+
+```tsx
+import React from "react";
+
+import ReactDOM from "react-dom/client";
+
+import { BrowserRouter, Navigate, Route, Routes } from "react-router-dom";
+
+import {
+  DocsEngine,
+  DocsPageRenderer,
+  useCurrentPage,
+} from "elseware-docs-engine";
+
+import docs from "./docs";
+
+import "elseware-docs-engine/dist/index.css";
+
+function Documentation() {
+  const page = useCurrentPage();
+
+  return page ? (
+    <DocsPageRenderer content={page.content} />
+  ) : (
+    <Navigate to="/docs/getting-started/intro" replace />
+  );
+}
+
+ReactDOM.createRoot(document.getElementById("root")!).render(
+  <React.StrictMode>
+    <BrowserRouter>
+      <DocsEngine docs={docs} basePath="/docs">
+        <Routes>
+          <Route path="/docs/*" element={<Documentation />} />
+        </Routes>
+      </DocsEngine>
+    </BrowserRouter>
+  </React.StrictMode>,
+);
+```
+
+When deploying this as a single-page application, configure the host to
+rewrite document requests to `index.html` so direct links and browser reloads
+reach React Router.
+
+---
+
+## Docs Structure Example
+
+```ts
+import intro from "./getting-started/intro.md?raw";
+
+import { DocsCategory } from "elseware-docs-engine";
+
+const docs: DocsCategory[] = [
+  {
+    title: "Getting Started",
+
+    path: "/getting-started",
+
+    children: [
+      {
+        title: "Introduction",
+
+        path: "/intro",
+
+        content: intro,
+      },
+    ],
+  },
+];
+
+export default docs;
+```
+
+---
+
+## Markdown Features
+
+- Headings
+- Tables
+- Lists
+- Images
+- Links
+- Quotes
+- Code blocks
+- Syntax highlighting
+- Nested navigation
+
+---
+
+## Development
+
+```bash
+npm install
+npm run dev
+```
+
+### Code quality
+
+```bash
+npm run typecheck        # TypeScript 7 project check
+npm run lint             # TypeScript and React rules with Oxlint
+npm run format:check
+npm run deadcode
+npm run build            # ESM, CommonJS, CSS, and declarations
+npm run validate         # Every quality gate and the production build
+```
+
+TypeScript 7 is the only compiler dependency. `tsup` bundles JavaScript and
+CSS, then the TypeScript 7 CLI emits the declaration files. Oxlint provides
+TypeScript and React linting without relying on the removed legacy compiler
+API.
+
+Staged source files are linted and formatted automatically by the Husky
+pre-commit hook.
+
+---
+
+## License
+
+MIT License
+
+---
+
+## Author
+
+elseware Technology

package/dist/components/docs-page-renderer/DocsPageRenderer.d.ts

@@ -0,0 +1,6 @@
+interface DocsPageRendererProps {
+    content: string;
+}
+declare function DocsPageRenderer({ content }: DocsPageRendererProps): import("react").JSX.Element;
+export default DocsPageRenderer;
+//# sourceMappingURL=DocsPageRenderer.d.ts.map

package/dist/components/docs-page-renderer/DocsPageRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsPageRenderer.d.ts","sourceRoot":"","sources":["../../../src/components/docs-page-renderer/DocsPageRenderer.tsx"],"names":[],"mappings":"AAEA,UAAU,qBAAqB;IAC7B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,iBAAS,gBAAgB,CAAC,EAAE,OAAO,EAAE,EAAE,qBAAqB,+BAE3D;eAEc,gBAAgB"}

package/dist/components/index.d.ts

@@ -0,0 +1,3 @@
+import DocsPageRenderer from "./docs-page-renderer/DocsPageRenderer";
+export { DocsPageRenderer };
+//# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,uCAAuC,CAAC;AAErE,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/context/DocsContext.d.ts

@@ -0,0 +1,7 @@
+import { type DocsCategory } from "../types";
+export interface DocsContextType {
+    docs: DocsCategory[];
+    basePath: string;
+}
+export declare const DocsContext: import("react").Context<DocsContextType | undefined>;
+//# sourceMappingURL=DocsContext.d.ts.map

package/dist/context/DocsContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsContext.d.ts","sourceRoot":"","sources":["../../src/context/DocsContext.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,YAAY,EAAE,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,WAAW,sDAEvB,CAAC"}

package/dist/context/DocsProvider.d.ts

@@ -0,0 +1,10 @@
+import type { ReactNode } from "react";
+import { type DocsCategory } from "../types";
+interface DocsProviderProps {
+    docs: DocsCategory[];
+    basePath: string;
+    children: ReactNode;
+}
+declare function DocsProvider({ docs, basePath, children }: DocsProviderProps): import("react").JSX.Element;
+export default DocsProvider;
+//# sourceMappingURL=DocsProvider.d.ts.map

package/dist/context/DocsProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsProvider.d.ts","sourceRoot":"","sources":["../../src/context/DocsProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAIvC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C,UAAU,iBAAiB;IACzB,IAAI,EAAE,YAAY,EAAE,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,iBAAS,YAAY,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,iBAAiB,+BAMpE;eAEc,YAAY"}

package/dist/context/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./DocsContext";
+export * from "./DocsProvider";
+//# sourceMappingURL=index.d.ts.map

package/dist/context/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/context/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC"}

package/dist/engine/DocsEngine.d.ts

@@ -0,0 +1,10 @@
+import type { ReactNode } from "react";
+import { type DocsCategory } from "../types";
+interface DocsEngineProps {
+    docs: DocsCategory[];
+    basePath?: string;
+    children: ReactNode;
+}
+declare function DocsEngine({ docs, basePath, children }: DocsEngineProps): import("react").JSX.Element;
+export default DocsEngine;
+//# sourceMappingURL=DocsEngine.d.ts.map

package/dist/engine/DocsEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsEngine.d.ts","sourceRoot":"","sources":["../../src/engine/DocsEngine.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAIvC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAG7C,UAAU,eAAe;IACvB,IAAI,EAAE,YAAY,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,iBAAS,UAAU,CAAC,EAAE,IAAI,EAAE,QAAc,EAAE,QAAQ,EAAE,EAAE,eAAe,+BAQtE;eAEc,UAAU"}

package/dist/engine/index.d.ts

@@ -0,0 +1,3 @@
+import DocsEngine from "./DocsEngine";
+export { DocsEngine };
+//# sourceMappingURL=index.d.ts.map

package/dist/engine/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/engine/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/hooks/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./useCurrentDocsSection";
+export * from "./useCurrentPage";
+export * from "./useDocs";
+export * from "./useScopedSidebar";
+export * from "./useSidebar";
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC"}

package/dist/hooks/useCurrentDocsSection.d.ts

@@ -0,0 +1,2 @@
+export declare function useCurrentDocsSection(): import("..").DocsCategory | undefined;
+//# sourceMappingURL=useCurrentDocsSection.d.ts.map

package/dist/hooks/useCurrentDocsSection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCurrentDocsSection.d.ts","sourceRoot":"","sources":["../../src/hooks/useCurrentDocsSection.ts"],"names":[],"mappings":"AAMA,wBAAgB,qBAAqB,0CAYpC"}

package/dist/hooks/useCurrentPage.d.ts

@@ -0,0 +1,6 @@
+interface UseCurrentPageProps {
+    debug?: boolean;
+}
+export declare function useCurrentPage({ debug }?: UseCurrentPageProps): import("..").DocsPage | null;
+export {};
+//# sourceMappingURL=useCurrentPage.d.ts.map

package/dist/hooks/useCurrentPage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCurrentPage.d.ts","sourceRoot":"","sources":["../../src/hooks/useCurrentPage.ts"],"names":[],"mappings":"AAMA,UAAU,mBAAmB;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,wBAAgB,cAAc,CAAC,EAAE,KAAa,EAAE,GAAE,mBAAwB,gCAkBzE"}

package/dist/hooks/useDocs.d.ts

@@ -0,0 +1,2 @@
+export declare function useDocs(): import("..").DocsContextType;
+//# sourceMappingURL=useDocs.d.ts.map

package/dist/hooks/useDocs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDocs.d.ts","sourceRoot":"","sources":["../../src/hooks/useDocs.ts"],"names":[],"mappings":"AAIA,wBAAgB,OAAO,iCAQtB"}

package/dist/hooks/useScopedSidebar.d.ts

@@ -0,0 +1,2 @@
+export declare function useScopedSidebar(): import("elseware-ui").MenuNode[];
+//# sourceMappingURL=useScopedSidebar.d.ts.map

package/dist/hooks/useScopedSidebar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useScopedSidebar.d.ts","sourceRoot":"","sources":["../../src/hooks/useScopedSidebar.ts"],"names":[],"mappings":"AAKA,wBAAgB,gBAAgB,qCAU/B"}

package/dist/hooks/useSidebar.d.ts

@@ -0,0 +1,2 @@
+export declare function useSidebar(): import("elseware-ui").MenuNode[];
+//# sourceMappingURL=useSidebar.d.ts.map

package/dist/hooks/useSidebar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../src/hooks/useSidebar.ts"],"names":[],"mappings":"AAIA,wBAAgB,UAAU,qCAIzB"}