프로젝트 소개
Ciderpress는 최소한의 설정으로 마크다운 파일을 완전한 문서 사이트로 변환하는, 모노레포용으로 설계된 문서 프레임워크입니다.
주요 기능:
- 구조 적합성: 경직된 구조를 강요하기보다 기존 레포지토리 레이아웃에 맞춰 조정됩니다.
- 통합 설정: 사이드바, 탐색, 푸터, 편집 링크, 버전 표시, 공지 사항, 테마를 단일 설정 파일에서 제어합니다.
- 내장 테마: honeycrisp, grannysmith, midnight, arcade 네 가지 테마가 기본 제공되며, 각 테마는 완전한 다크 모드를 지원합니다. 사용자 정의 테마도 지원됩니다.
- 모노레포 지원: 워크스페이스 카드, OpenAPI 연동, Liquid 템플릿 지원이 포함되어 있으며 내부 개발자 문서를 대상으로 합니다.
사용하려면 npm으로 설치하고 제목, 경로, 마크다운 포함 패턴으로 섹션을 선언하는 설정 파일(ciderpress.config.ts)을 정의해야 합니다. 이 도구는 세 가지 명령을 제공합니다: 핫 리로드 개발 서버를 시작하는 `npx ciderpress dev`, 프로덕션 빌드를 생성하는 `npx ciderpress build`, 빌드된 사이트를 로컬에서 미리 보는 `npx ciderpress serve`.
MIT 라이선스에 따라 배포됩니다.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.