การติดตั้ง #

ข้อกำหนดเบื้องต้น #

ก่อนเริ่มติดตั้ง ตรวจสอบให้แน่ใจว่าระบบของคุณมีสิ่งต่อไปนี้:

• Node.js เวอร์ชัน 18.0 ขึ้นไป (node --version)
• npm หรือ yarn หรือ pnpm (แนะนำ pnpm)
• Git เวอร์ชัน 2.30 ขึ้นไป
• PostgreSQL 15+ หรือ SQLite (สำหรับ development)
• Docker (ไม่จำเป็น แต่แนะนำสำหรับ production)

ติดตั้งแบบด่วน #

ติดตั้ง DEVDOCS ด้วยคำสั่งเดียว:

# ติดตั้ง CLI แบบ global
$ npm install -g @devdocs/cli

# หรือใช้ npx โดยไม่ต้องติดตั้ง
$ npx @devdocs/cli init my-project

ขั้นตอนการติดตั้งทีละขั้น #

$ devdocs init my-docs --template thai-docs

# Output:
  สร้างโปรเจกต์ "my-docs" สำเร็จ
  โครงสร้าง: 12 ไฟล์, 3 โฟลเดอร์
  Template: thai-docs (ภาษาไทย)

$ cd my-docs
$ npm install

$ npm run dev

# Output:
  DEVDOCS v3.2.0
  Local:   http://localhost:3000
  Network: http://192.168.x.x:3000
  
  พร้อมใช้งาน — เปิดเบราว์เซอร์เพื่อดูเอกสาร

การตั้งค่า Configuration #

สร้างไฟล์ devdocs.config.js ที่ root ของโปรเจกต์:

 1// devdocs.config.js
 2import { defineConfig } from '@devdocs/core';
 3
 4export default defineConfig({
 5  title: 'คู่มือระบบ TOPMANIDMB',
 6  description: 'เอกสารสำหรับทีม AI War Room',
 7  lang: 'th',
 8
 9  // การตั้งค่า theme
10  theme: {
11    primaryColor: '#3b82f6',
12    logo: '/assets/logo.svg',
13    darkMode: true,
14  },
15
16  // Sidebar navigation
17  sidebar: [
18    {
19      text: 'เริ่มต้น',
20      items: [
21        { text: 'การติดตั้ง', link: '/getting-started/installation' },
22        { text: 'Quick Start', link: '/getting-started/quick-start' },
23      ],
24    },
25  ],
26
27  // Search configuration
28  search: {
29    provider: 'local',
30    options: { sensitivity: 'accent' },
31  },
32});

สำหรับผู้ใช้ Python สามารถใช้ SDK เชื่อมต่อได้ดังนี้:

 1from devdocs import DevDocsClient
 2from devdocs.models import SearchQuery, Document
 3
 4# เชื่อมต่อ API
 5client = DevDocsClient(
 6    api_key="dd_sk_your_api_key_here",
 7    base_url="https://api.devdocs.io/v3",
 8)
 9
10# ค้นหาเอกสาร
11results = client.search(
12    SearchQuery(
13        query="การติดตั้ง",
14        lang="th",
15        limit=10,
16    )
17)
18
19# แสดงผลลัพธ์
20for doc in results.items:
21    print(f"{doc.title} — {doc.score:.2f}")

ตัวเลือกการตั้งค่า #

ตัวเลือกทั้งหมดที่ใช้ได้ใน configuration file:

Environment Variables #

สร้างไฟล์ .env ที่ root ของโปรเจกต์:

# DEVDOCS Configuration
DEVDOCS_API_KEY=dd_sk_your_api_key
DEVDOCS_BASE_URL=https://api.devdocs.io/v3
DEVDOCS_PORT=3000

# Database (ใช้กับ full-text search)
DATABASE_URL=postgresql://user:pass@localhost:5432/devdocs

# Optional: Analytics
ANALYTICS_ID=UA-XXXXXXXXX-X

ขั้นตอนถัดไป #