# Documentation

### compodoc

<p class="callout info">version 1.1.26</p>

Installer `compodoc` avec `npm` :

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

Scripts possibles dans le `package.json` :

```json
    "doc:build": "compodoc",
    "doc:serve": "compodoc --serve --open",
```

Fichier `.compodocrc.json`, à la racine du projet :

```json
{
  "tsconfig": "tsconfig.doc.json",
  "output": "docs",
  "theme": "default",
  "hideGenerator": true,
  "disablePrivate": true,
  "disableInternal": true,
  "language": "fr"
}
```

Fichier `tsconfig.doc.json`, à la racine du projet :

```json
{
  "include": ["src/app/**/*.ts"],
  "exclude": ["src/app/**/*.spec.ts", "src/app/dev/**/*.ts"]
}
```

### standard-version

<p class="callout info">version 9.5.0</p>

Permet d'alimenter le fichier `CHANGELOG.md` automatiquement avec les commits.

Installer `standard-version` avec `npm` :

```bash
npm i -D standard-version
```

Scripts possibles dans le `package.json` :

```json
    "release": "standard-version",
    "release:major": "npm run release -- --release-as major",
    "release:minor": "npm run release -- --release-as minor",
    "release:patch": "npm run release -- --release-as patch",
```

Fichier `.versionrc.json`, à la racine du projet :

```json
{
  "header": "Changelog",
  "types": [
    { "type": "feat", "section": "Features" },
    { "type": "fix", "section": "Bug Fixes" },
    { "type": "chore", "section": "Chores" },
    { "type": "docs", "section": "Documentation" },
    { "type": "style", "section": "Code Style" },
    { "type": "refactor", "section": "Refactoring" },
    { "type": "perf", "section": "Performance Improvements" },
    { "type": "test", "section": "Tests" },
    { "type": "build", "section": "Build System" },
    { "type": "ci", "section": "Continuous Integration" }
  ]
}
```

<div id="bkmrk-"><div>  
</div>  
</div>