docmd-io/docmd

docmd – 인간과 기계를 위한 문서

무엇인가요

• 일반 Markdown 파일 폴더를 기능이 풍부한 정적 문서 웹사이트 및 기계가 읽을 수 있는 아티팩트 세트로 변환하는 오픈소스 컴파일러입니다.
• 동일한 소스는 다음 형식으로 출력됩니다:
  • HTML 웹사이트 (SPA 스타일, 라이트/다크 모드)
  • 오프라인 검색 인덱스 (키워드 검색 + 선택적 벡터 검색)
  • llms.txt / llms-full.txt – 대규모 언어 모델(LLM)에 공급하기 위한 순수 텍스트 덤프
  • RAG 파이프라인용 오픈 지식 포맷(OKF) 번들
  • 코딩 에이전트용 MCP 서버 인터페이스
  • SEO 자산 (사이트맵, 오픈 그래프, robots.txt)

AI/LLM 워크플로우에서 중요한 이유

• 현대 문서는 사람, 검색 엔진, 그리고 검색 증강 생성(RAG)을 수행하는 AI 에이전트의 세 가지 대상을 동시에 만족시켜야 합니다.
• docmd는 단일 처리에서 이러한 모든 출력물을 생성하며, Markdown 소스를 유일한 진실의 원천으로 유지합니다.
• 본체에는 RAG 기반 AI 어시스턴트 가 포함되어 있으며, 생성된 llms.txt 컨텍스트를 사용해 질문에 답변할 수 있고, 클라우드 리레이 서비스를 통해 브라우저에 자격 증명을 노출하지 않고도 어떤 LLM 제공자와도 통신할 수 있습니다.

주요 기능 (사용자 중심)

• 제로 설정 시작: npx @docmd/core dev 로 즉시 라이브 미리보기 제공.
• 정적 사이트 생성 (docmd build)은 Vercel, Netlify, Cloudflare Pages, S3 등 모든 정적 호스팅과 호환됩니다.
• 내장 SEO, 오픈 그래프, 사이트맵, 버전 관리, i18n, OpenAPI 렌더링.
• PWA 지원, 스레드형 논의, KaTeX 등 선택적 플러그인 제공.

주요 기능 (기계 중심)

• AI 어시스턴트 – RAG를 통해 문서를 검색하는 채팅 UI.
• MCP 서버 – docmd mcp 로 실행되는 간단한 프로토콜로 외부 코딩 에이전트가 문서를 검색, 읽기, 검증할 수 있음.
• llms.txt / llms-full.txt – LLM 프롬프팅용으로 바로 붙여넣을 수 있는 컨텍스트 파일.
• OKF 번들 – 하류 RAG 파이프라인에서 사용 가능한 구조화된 지식 패키지.
• 의미적 검색 – 전통적인 키워드 검색에 더해 선택적 벡터 기반 검색 지원.

사용 방법

1. 전역 설치 (npm i -g @docmd/core) 또는 npx/Docker로 실행.
2. .md 파일 폴더를 지정:

   npx @docmd/core dev   # 개발 서버
   npx @docmd/core build # 정적 출력
   

3. docmd add <plugin> 로 플러그인 추가 (예: pwa, threads).
4. AI 통합을 위해 ai 코어 플러그인(기본 포함)을 설치하고 클라우드 리레이 또는 자체 LLM 엔드포인트를 구성.

확장성

• 플러그인 시스템: 코어 플러그인으로 대부분의 요구를 충족; npm에서 또는 로컬로 추가 가능.
• 프로그래밍 API: import { build } from '@docmd/core' 로 CI 파이프라인에서 컴파일러 호출 가능.
• 설정은 선택 사항; 간단한 docmd.config.json 으로 제목, 사이트 URL, 소스/출력 디렉터리 등을 설정 가능.

커뮤니티 및 라이선스

• 코어 및 플러그인은 MIT 라이선스 – 자유롭게 사용, 수정, 자체 호스팅 가능.
• GitHub Discussions에서 활발한 커뮤니티, 공개 로드맵, 스폰서 옵션 제공.
• 문서, 마이그레이션 가이드(Docusaurus, VitePress, MkDocs, Starlight에서), 실시간 에디터는 모두 docmd.io 에 호스팅됨.

결론 docmd는 전통적인 문서 사이트와 AI 강화 워크플로우의 새로운 요구를 연결하는 개발자 친화적인 도구로, 동일한 Markdown 소스에서 독자와 LLM 모두에게 서비스를 제공할 수 있습니다.