# Compodoc

Compodoc est un outil open-source permettant de générer rapidement une documentation de votre application Angular.

## Installation

La commande suivante installe le module `@compodoc/compodoc`.

```bash
yarn add --dev @compodoc/compodoc
```

## Utilisation

Définissez ensuite un npm "script" dans votre fichier `package.json`

```javascript
"scripts": {
  "compodoc": "compodoc -p src/tsconfig.app.json"
}
```

Et lancez la ensuite dans votre terminal :

```bash
yarn compodoc
```

Vous obtiendrez ensuite la documentation générée dans le dossier `documentation`. Ouvrez la dans votre navigateur préféré.

## Example

Un example de documentation générée est disponible sur ce lien : <https://compodoc.github.io/compodoc-demo-todomvc-angular/>

## Remerciement

Merci à Vincent OGLOBLINSKY pour sa contribution !

<https://github.com/vogloblinsky>

{% embed url="<https://github.com/vogloblinsky>" %}

<https://twitter.com/vogloblinsky>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guide-angular.wishtack.io/tools/compodoc.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.