docz란?

다음과 같은 원칙을 가지고 있습니다.

• 불필요한 설정을 없애고 배우기 쉽게.
• 빠른 성능
• 쉬운 커스터마이징
• MDX 베이스 - .mdx 파일 기반의 독립적인 문서로 관리 가능
• 유연한 솔루션을 위한 플러그인 지원

설치

yarn add docz docz-theme-default -D

실행

package.json 선택사항

"scripts": {
	"docz:dev": "docz dev",
	"docz:build": "docz build"
}

yarn docz:dev

실행 하게 되면 .mdx 파일을 찾아 빌드 시켜준다.

create-react-app 에서 사용할 때 의존성 버전 문제로 다음과 같은 에러가 발생한다.

Uncaught TypeError: Cannot read property 'close' of undefined

당황하지 말고 package.json에 아래 부분을 추가 한 후 yarn을 실행 시켜서 버전을 변경 하자.