okineadev/vitepress-plugin-llms

📜 A VitePress plugin for generating LLM-friendly documentation

해결하는 문제

기존 웹사이트 문서는 대규모 언어 모델(LLM)이 효율적으로 처리할 수 있도록 설계되지 않은 경우가 많아 과도하게 무겁고 혼잡합니다. 이 플러그인은 VitePress 문서를 LLM 소비에 최적화된 원시적이고 간결한 Markdown 형식으로 변환합니다.

작동 방식

빌드 프로세스 중에 사이트 페이지의 LLM 친화적 버전을 자동으로 생성하는 Vite 플러그인으로 통합됩니다. llmstxt.org 표준을 따르며 다음과 같은 파일을 생성합니다:

  • llms.txt: 모든 문서 섹션에 대한 링크를 포함하는 메인 인덱스 파일.
  • llms-full.txt: 사이트 전체 문서가 하나의 컴파일된 파일에 포함된 파일.
  • 각 페이지용 개별 .md 파일.

또한 <llm-only><llm-exclude>라는 특수 태그를 제공하여 AI 모델 전용 지침을 포함하거나 인간 중심 콘텐츠를 AI 버전에서 제거할 수 있습니다.

대상 사용자

VitePress를 사용해 프로젝트 문서를 호스팅하는 개발자 및 기술 작가로서, AI 에이전트와 LLM이 더 쉽게 활용할 수 있도록 문서를 더 접근성 있게 만들고 싶은 사람.

주요 특징

  • 제로 설정: 설치 후 바로 사용 가능.
  • 콘텐츠 제어: <llm-only>를 사용해 AI 전용 지침을 제공하고, <llm-exclude>를 사용해 LLM에 불필요한 정보를 제거할 수 있음.
  • 표준 준수: llmstxt.org 표준을 준수합니다.
  • 사용자 친화적 도구: 방문자에게 "Markdown으로 복사" 및 "Markdown으로 다운로드" 버튼을 선택적으로 제공합니다.
  • 광범위한 채택: Vite, Vue.js, Vitest와 같은 주요 프로젝트에서 사용 중입니다.

관련

  • 프로젝트
  • 프로젝트
  • 프로젝트
  • 프로젝트
  • 프로젝트