documentation-generator 설명서
  1. 소개
  2. 설정 파일
  3. 커스텀 템플릿
  4. 꿀팁

documentation-generator 소개

documentation-generatoryamd등의 마크업 렌더러를 사용해서 이 페이지와 같은 설명서를 만들 수 있게 한다. 이 페이지는 기본으로 제공되는 템플릿을 사용하여 documentation-generator로 빌드한 것이다. So meta!

설치

npm install documentation-generator

사용법

문서를 생성하기 위해서는 먼저 문서 및 설정 파일을 작성하고 터미널에서 다음과 같이 입력하면 된다.

npx documentation-generator

또 다음과 같이 입력하면 가능한 옵션을 볼 수 있다.

npx documentation-generator --help