사전 요구 사항:
- Node.js 버전 19 이상
docs.json파일이 포함된 문서 리포지토리
사용자 지정 포트
기본적으로 Mintlify는 3000번 포트를 사용합니다.--port 플래그를 사용하여 Mintlify가 실행되는 포트를 사용자 지정할 수 있습니다. 예를 들어, 3333번 포트에서 Mintlify를 실행하려면 다음 명령을 사용하세요:
Mintlify 버전
각 CLI 릴리스는 특정 버전의 Mintlify와 연동됩니다. 로컬 미리보기가 프로덕션 버전과 일치하지 않는 경우 CLI를 업데이트해 주세요:링크 유효성 검사
CLI를 사용하여 문서 내의 링크 유효성을 검사할 수 있습니다. 깨진 링크를 식별하려면 다음 명령을 사용하세요:배포
배포가 성공하면 다음과 같은 화면이 표시됩니다:
코드 포맷팅
MDX를 인식하고 형식을 맞추기 위해 IDE 확장 프로그램을 사용하는 것이 좋습니다. VSCode 사용자라면 구문 강조를 위한 MDX VSCode extension과 코드 포맷팅을 위한 Prettier를 고려해 보세요.문제 해결
오류: darwin-arm64 런타임을 사용하여 "sharp" 모듈을 로드할 수 없습니다
오류: darwin-arm64 런타임을 사용하여 "sharp" 모듈을 로드할 수 없습니다
이는 오래된 노드 버전 때문일 수 있습니다. 다음을 시도해 보세요:
- 현재 설치된 CLI 버전 제거:
npm remove -g mint - Node v19 이상으로 업그레이드.
- CLI 재설치:
npm i -g mint
문제: 알 수 없는 오류가 발생함
문제: 알 수 없는 오류가 발생함
해결 방법: 장치의 루트로 이동하여
~/.mintlify 폴더를 삭제합니다. 그런 다음 mint dev를 다시 실행하세요.