beautiful-docs

Beautiful Docs는 소프트웨어 또는 여러 사용자를 대상으로 하는 기타 프로젝트를 위한 문서를 작성하는 사람들을 위해 선별된 참고 자료입니다. 이 프로젝트 자체는 문서를 생성하지 않으며, 대신 우수하다고 평가된 문서 사례와 이를 지원하는 리소스들을 링크로 제공합니다. 문서 사례는 언어 및 프레임워크 레퍼런스, API 가이드, 운영체제 매뉴얼, 데이터베이스, 개발자 서비스 등 다양한 분야를 아우릅니다. 포함된 항목으로는 Redis Commands, GitHub Developer Docs, Django, Ruby on Rails, Stripe, Rust, MongoDB, FastAPI, Supabase 등이 있습니다. 일부 항목은 인터랙티브 예제, 버전 관리, 검색 기능, 간결한 문체, 다이어그램, 내비게이션, 언어 지원 등 특정 장점을 강조하여 소개합니다. 두 번째 섹션에서는 TomDoc, Write the Docs, Google Developer Documentation Style Guide, API Blueprint, Diátaxis 등 기술 문서 작성 및 문서 설계에 관한 리소스를 다룹니다. 마지막 섹션에서는 Sphinx, MkDocs, Read the Docs, Slate, Docusaurus, VuePress, VitePress, Docsify, Pandoc, Doxygen 등 문서를 생성, 변환, 게시 또는 유지 관리하는 데 사용되는 도구들을 나열합니다. 이 저장소는 풀 리퀘스트를 통해 유지 관리됩니다. 기여자는 항목이 유용한 이유를 설명하고, 본인 또는 원래 기여자를 명시하며, 목록의 추가 순서를 유지하도록 요청받습니다.