Documentation

Compodoc는 Angular 응용 프로그램을 위한 문서화 도구입니다. Nest와 Angular는 매우 유사해 Compodoc은 Nest 응용 프로그램도 지원합니다.

Setup

기존 Nest 프로젝트 내에서 Compodoc을 설정하는 것은 매우 간단합니다. npm을 설치한 상태에서 OS 터미널에 다음 명령을 사용하여 dev-dependency를 추가하십시오.

$ npm i -D @compodoc/compodoc

공식 문서에 따라 아래 명령 (npm 6 필수)을 사용하여 문서를 생성할 수 있습니다.

$ npx compodoc -p tsconfig.json -s

브라우저를 열고 http://localhost:8080으로 이동하십시오. 초기 Nest CLI 프로젝트가 표시되어야 합니다.

Compodoc 프로젝트 여기에 기여하고 참여할 수 있습니다.

Last updated 5 years ago