이 문서 인프라에 대하여

SRDD 문서화는 GitHub 저장소의 `documentation` 디렉토리에 저장된 Markdown 파일을 사용합니다. 각 Markdown 파일은 메타데이터를 위한 YAML 프론트 매터(front matter)를 포함하며, 내용은 표준 GitHub Flavored Markdown을 사용합니다. 문서 간 링크는 플랫폼에 구애받지 않는 링크를 용이하게 하기 위해 자리 표시자 구문을 사용합니다. GitHub Actions 파이프라인은 문서의 빌드 및 게시를 자동으로 처리합니다. 파이프라인은 먼저 Jekyll을 사용하여 GitHub Pages 배포를 위한 자리 표시자를 변환합니다. 다음으로, 두 단계의 과정을 거쳐 Dev.to에 콘텐츠를 동기화합니다. 첫 번째 단계는 Dev.to 아티클을 생성하거나 업데이트하고 생성된 URL을 캡처합니다. 두 번째 단계는 생성된 URL 맵을 사용하여 Dev.to의 내부 링크를 해결합니다. Dev.to 아티클의 정식 URL은 GitHub Pages 버전을 가리키며, SEO 이점과 단일 진실 소스를 보장합니다. 새로운 문서를 추가하려면 Markdown 파일을 생성하고 자리 표시자 구문을 사용하여 링크하면 됩니다. 파이프라인은 Dev.to API 키와 GitHub Pages URL을 환경 변수로 필요로 합니다. 이 접근 방식은 SRDD 문서화에 "한 번 작성, 어디든 게시" 기능을 가능하게 합니다. 이 프로세스는 콘텐츠가 여러 플랫폼에서 일관되게 사용 가능하도록 보장합니다.