> For the complete documentation index, see [llms.txt](https://jakekwak.gitbook.io/nestjs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jakekwak.gitbook.io/nestjs/recipes/untitled-7.md).

# Documentation

## Documentation

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

## Setup

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

```bash
$ npm i -D @compodoc/compodoc
```

## Generation

[공식 문서](https://compodoc.app/guides/usage.html)에 따라 아래 명령 (npm 6 필수)을 사용하여 문서를 생성할 수 있습니다.

```bash
$ npx compodoc -p tsconfig.json -s
```

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

## Contribute

Compodoc 프로젝트 [여기](https://github.com/compodoc/compodoc)에 기여하고 참여할 수 있습니다.