Doctave

Doctave는 Markdown 작성의 유연성과 전문 문서 호스팅의 강력함을 결합한 문서 플랫폼입니다. 사용자는 문서를 일반 텍스트 파일로 작성하여 코드와 함께 Git에 저장하고, Doctave가 이를 아름답고 검색 가능한 문서 웹사이트로 변환해 줍니다.

이 플랫폼은 일반 Markdown 가이드와 API 문서를 위한 OpenAPI 명세를 모두 지원합니다. 변경 사항이 있을 때 자동으로 미리보기 환경을 생성하여 팀이 게시 전에 업데이트를 검토할 수 있도록 합니다. 모든 것이 Git 저장소에 보관되어 문서에 대한 완전한 버전 관리를 제공합니다.

Doctave Studio는 실시간 미리보기, 자동 완성 제안, 끊어진 링크 검사 및 맞춤법 검사를 제공하는 데스크톱 동반 애플리케이션입니다. 이 도구들은 팀이 최신 상태이고 정확한 문서를 작성하는 데 도움을 줍니다.

Doctave를 시작하는 것은 간단합니다. 효과적으로 사용하는 방법은 다음과 같습니다:

• 코드 저장소에 문서 폴더를 만들고 Markdown 파일을 사용하여 내용을 작성하세요. 시작 페이지로 README.md 파일을 포함하세요.

• 컴퓨터에 Doctave Studio를 설치하여 문서를 작성하는 동안 실시간 업데이트와 함께 로컬에서 미리보기를 하세요.

• doctave.yml 구성 파일을 설정하여 문서 구조, 테마 색상 및 내비게이션 링크를 정의하세요.

• Git 저장소를 Doctave 플랫폼에 연결하세요. 변경 사항을 푸시할 때마다 Doctave가 자동으로 게시된 문서를 업데이트합니다.

• API 문서의 경우, OpenAPI 명세 파일을 저장소에 추가하세요. Doctave가 자동으로 인터랙티브 API 참조 페이지를 생성합니다.

• Git 브랜치를 사용하여 문서의 다양한 버전을 관리하세요. 변경 사항을 게시하기 전에 검토할 수 있도록 풀 리퀘스트를 생성하고, Doctave가 각 풀 리퀘스트에 대한 미리보기 링크를 생성합니다.

• 버전 관리가 포함된 Git 기반 문서 워크플로우

• 실시간 미리보기가 가능한 Doctave Studio 데스크탑 에디터

• API 문서를 위한 OpenAPI 사양 지원

• 풀 리퀘스트용 자동 미리보기 환경

• 다중 버전 문서 관리

• 모든 콘텐츠에 대한 내장 검색 기능

• 맞춤형 브랜딩 및 테마 옵션

• 독자 분석 및 피드백 수집

• 자동 배포를 위한 CI/CD 통합

• 비밀번호 보호 문서 옵션