Feat/docs

package.json

@@ -14,7 +14,10 @@
     "@tailwindcss/vite": "^4.2.1",
     "axios": "^1.13.5",
     "framer-motion": "^12.34.3",
+    "fuse.js": "^7.1.0",
     "github-markdown-css": "^5.9.0",
+    "github-slugger": "^2.0.0",
+    "highlight.js": "^11.11.1",
     "js-md5": "^0.8.3",
     "jszip": "^3.10.1",
     "react": "^19.2.4",

public/docs/en/_structure.json

@@ -0,0 +1,30 @@
+{
+  "title": "Documentation",
+  "items": [
+    {
+      "title": "Introduction",
+      "slug": "index",
+      "description": "Docs portal overview"
+    },
+    {
+      "title": "Guides",
+      "children": [
+        {
+          "title": "Quick Start",
+          "slug": "guide/quick-start",
+          "description": "Integrate docs pages quickly"
+        }
+      ]
+    },
+    {
+      "title": "API",
+      "children": [
+        {
+          "title": "Renderer",
+          "slug": "api/renderer",
+          "description": "Markdown rendering capabilities"
+        }
+      ]
+    }
+  ]
+}

public/docs/en/api/renderer.md

@@ -0,0 +1,17 @@
+# Renderer Capability
+
+The docs page renders markdown via `react-markdown` + `remark-gfm` + `github-markdown-css`.
+
+## Supported Features
+
+- Headings, lists, tables, blockquotes
+- Syntax-highlighted code blocks
+- Auto-generated TOC for current page
+
+## Extension Ideas
+
+You can extend this setup with:
+
+- Mermaid diagrams
+- Admonition blocks
+- Version switcher

public/docs/en/guide/quick-start.md

@@ -0,0 +1,26 @@
+# Quick Start
+
+This page explains how to add a new documentation entry.
+
+## Step 1: Add a markdown file
+
+Create a file under a language directory:
+
+```text
+public/docs/en/guide/new-topic.md
+```
+
+## Step 2: Update navigation structure
+
+Add a node to `_structure.json`:
+
+```json
+{
+  "title": "New Topic",
+  "slug": "guide/new-topic"
+}
+```
+
+## Step 3: Verify route
+
+Open `/docs/guide/new-topic` and ensure content renders and appears in the sidebar.

public/docs/en/index.md

@@ -0,0 +1,25 @@
+# Majdata Docs
+
+Welcome to the Majdata documentation portal. This site is rendered with the existing github-markdown pipeline and includes:
+
+- Collapsible sidebar navigation
+- Right-side table of contents
+- Syntax-highlighted code blocks
+- Previous / Next navigation
+- Client-side document search
+
+## Suggested Structure
+
+Keep each topic in its own markdown file and maintain sidebar order in `_structure.json`.
+
+## Example Code Block
+
+```ts
+export function hello(name: string): string {
+  return `hello, ${name}`;
+}
+```
+
+## Next Step
+
+Continue with the Quick Start page to add your own docs content.

public/docs/ja/_structure.json

@@ -0,0 +1,30 @@
+{
+  "title": "ドキュメント",
+  "items": [
+    {
+      "title": "イントロダクション",
+      "slug": "index",
+      "description": "ドキュメント全体の概要"
+    },
+    {
+      "title": "ガイド",
+      "children": [
+        {
+          "title": "クイックスタート",
+          "slug": "guide/quick-start",
+          "description": "ドキュメントを素早く追加"
+        }
+      ]
+    },
+    {
+      "title": "API",
+      "children": [
+        {
+          "title": "レンダラー",
+          "slug": "api/renderer",
+          "description": "Markdown レンダリング能力"
+        }
+      ]
+    }
+  ]
+}

public/docs/ja/api/renderer.md

@@ -0,0 +1,9 @@
+# レンダラー能力
+
+`react-markdown` と `remark-gfm`、`github-markdown-css` を使って文書を表示します。
+
+## 対応内容
+
+- 基本的な markdown 要素
+- コードハイライト
+- 現在ページ TOC

public/docs/ja/guide/quick-start.md

@@ -0,0 +1,15 @@
+# クイックスタート
+
+新しいドキュメントページを追加する手順です。
+
+## ステップ1
+
+言語ディレクトリに markdown を追加します。
+
+## ステップ2
+
+`_structure.json` にナビ項目を追加します。
+
+## ステップ3
+
+`/docs/...` で表示できることを確認します。

public/docs/ja/index.md

@@ -0,0 +1,13 @@
+# Majdata Docs
+
+Majdata ドキュメントへようこそ。既存の github-markdown レンダリングを利用し、以下を提供します。
+
+- 折りたたみ可能な左ナビ
+- 右側 TOC
+- コードブロックのシンタックスハイライト
+- 前後ページナビ
+- クライアントサイド検索
+
+## 構成の考え方
+
+トピックごとに markdown を分け、`_structure.json` で順序を管理します。

public/docs/ko/_structure.json

@@ -0,0 +1,30 @@
+{
+  "title": "문서",
+  "items": [
+    {
+      "title": "소개",
+      "slug": "index",
+      "description": "문서 포털 개요"
+    },
+    {
+      "title": "가이드",
+      "children": [
+        {
+          "title": "빠른 시작",
+          "slug": "guide/quick-start",
+          "description": "문서 페이지 빠르게 추가"
+        }
+      ]
+    },
+    {
+      "title": "API",
+      "children": [
+        {
+          "title": "렌더러",
+          "slug": "api/renderer",
+          "description": "Markdown 렌더링 기능"
+        }
+      ]
+    }
+  ]
+}

public/docs/ko/api/renderer.md

@@ -0,0 +1,9 @@
+# 렌더러 기능
+
+문서 페이지는 `react-markdown` + `remark-gfm` + `github-markdown-css` 조합으로 렌더링됩니다.
+
+## 지원 항목
+
+- 기본 markdown 요소
+- 코드 하이라이트
+- 현재 페이지 TOC 자동 생성

public/docs/ko/guide/quick-start.md

@@ -0,0 +1,15 @@
+# 빠른 시작
+
+새 문서를 추가하는 방법입니다.
+
+## 1단계
+
+언어 디렉토리에 markdown 파일을 추가하세요.
+
+## 2단계
+
+`_structure.json`에 항목을 추가하세요.
+
+## 3단계
+
+`/docs/...` 경로에서 정상 렌더링을 확인하세요.

public/docs/ko/index.md

@@ -0,0 +1,9 @@
+# Majdata Docs
+
+Majdata 문서 포털에 오신 것을 환영합니다. 기존 github-markdown 렌더링 로직을 기반으로 다음 기능을 제공합니다.
+
+- 접을 수 있는 좌측 네비게이션
+- 우측 TOC
+- 코드 블록 문법 하이라이트
+- 이전 / 다음 페이지
+- 클라이언트 검색

public/docs/zh/_structure.json

@@ -0,0 +1,30 @@
+{
+  "title": "文档",
+  "items": [
+    {
+      "title": "简介",
+      "slug": "index",
+      "description": "文档站总览"
+    },
+    {
+      "title": "指南",
+      "children": [
+        {
+          "title": "快速开始",
+          "slug": "guide/quick-start",
+          "description": "在项目中接入 Docs 站"
+        }
+      ]
+    },
+    {
+      "title": "API",
+      "children": [
+        {
+          "title": "渲染器能力",
+          "slug": "api/renderer",
+          "description": "Markdown 渲染与扩展点"
+        }
+      ]
+    }
+  ]
+}

public/docs/zh/api/renderer.md

@@ -0,0 +1,17 @@
+# 渲染器能力
+
+Docs 页面使用 `react-markdown` + `remark-gfm` + `github-markdown-css` 进行渲染。
+
+## 已支持特性
+
+- 标题、列表、表格、引用
+- 代码块语法高亮
+- 自动生成当前页目录（TOC）
+
+## 扩展方向
+
+可以继续扩展：
+
+- mermaid 图渲染
+- admonition 提示块
+- 文档版本切换