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

npm install elseware-docs-engine

Import Styles

import "elseware-docs-engine/dist/index.css";

Basic Usage

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

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

npm run dev

Build

npm run build

License

MIT License

Author

elseware Technology