Retype Docs를 AI-Ready하게 만들기 및 llms.txt 자동화
Source: Dev.to
문서를 최신 상태로 유지하는 것도 중요하지만, 팀이나 파트너가 변경 사항을 빠르게 파악하도록 돕는 것은 또 다른 과제입니다. 우리 회사에서는 Retype을 문서 도구로 사용하고 있으며, 문서를 즉시 AI‑준비 상태로 만들어 요약, 검색 또는 내부 툴에서 활용하고 싶었습니다.
그때 등장한 것이 retype_llms 입니다. 가벼운 GitHub Action과 Python 도구로, Markdown 문서에서 바로 llms.txt 파일을 생성해 줍니다. 파일을 수동으로 내보내거나 URL·이미지 경로를 신경 쓸 필요 없이 자동으로 처리해 줍니다.
Why llms.txt?
AI 도구에 문서를 넣어 보거나 검색 인덱스를 만들다 보면 겪게 되는 어려움, 즉 여러 Markdown 파일, 상대 이미지 경로, front‑matter 헤더, 커스텀 라우트 등이 컨텍스트를 깨뜨리는 문제를 알고 계실 겁니다.
retype_llms는 이를 다음과 같이 해결합니다:
- 모든 Markdown을 하나의 구조화된 파일로 통합
- AI를 혼란스럽게 하는 YAML front‑matter 제거
- 파일 경로와 URL을 포함한 명확한 섹션 마커 추가
- 필요 시 상대 이미지 경로를 절대 URL로 변환
- Retype 라우팅 로직을 유지해 정확한 링크 제공
이 덕분에 AI 도구나 문서를 분석하는 스크립트가 깨끗하고 구조화된, 바로 사용할 수 있는 콘텐츠를 얻게 됩니다.
How it Fits in Your Workflow
Python 스크립트든 GitHub Action이든, retype_llms는 자연스럽게 통합됩니다:
- Python 스크립트 – 로컬이나 CI에서 필요할 때마다
llms.txt를 생성. - GitHub Action – 푸시마다 자동으로
llms.txt를 생성하고, 선택적으로 Retype 사이트 빌드 전에 실행. 파일은static/폴더에 저장돼 바로 사용 가능.
Example: Using with Retype Build Action
retype_llms를 Retype 빌드 직전에 삽입하면 llms.txt가 항상 최신 상태가 됩니다:
name: Build Retype Documentation
on:
push:
branches: [main]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Generate llms.txt
uses: zakaria-chahboun/retype_llms@v2.0.0
- name: Build Retype
uses: retypeapp/action-build@latest
- name: Deploy to GitHub Pages
uses: retypeapp/action-github-pages@latest
with:
update-branch: true기존 Retype 설정을 아무것도 바꾸지 않아도 😎 작동합니다 – 워크플로에 추가하기만 하면 됩니다.
Behind the Scenes
이 도구는 Retype의 로직을 그대로 따릅니다:
- 입력 감지 –
retype.yml에서 Markdown 소스 폴더를 자동으로 찾음. - 라우팅 – Retype의
permalink,route, 인덱스 파일 규칙에 맞는 URL 생성. - 슬러그화 – Retype의 소문자‑하이픈 URL 스타일과 일치.
- 통계 – 파일 수, 단어 수, 예상 토큰 수 ✨ 를 보고 (AI 연동에 유용).
이 모든 것이 llms.txt 출력이 문서 구조를 정확히 반영하도록 보장하며, 수동 정리 작업이 필요 없습니다.
Why You’ll Love It
- 완전 자동화: 파일 복사·내보내기 불필요.
- AI나 스크립트를 위한 링크·이미지 보존.
- GitHub Pages와 기존 Retype 빌드와 호환.
- 가볍고 설정이 쉬움.
한 번 사용해 보세요 👉
이 작은 추가만으로 수시간의 수작업을 절감하고 문서를 몇 분 안에 AI‑준비 상태로 만들 수 있습니다.
행복한 문서 작업 되세요! 🚀