# Node.js versions

Compodoc is tested with only LTS versions : v6.9.4 & v4.7.1

# Angular-CLI

Compodoc supports last Angular-CLI version : 1.0.0

Just run Compodoc in a fresh or existing project.

# Global installation

Install from npm :

```bash
npm install -g @compodoc/compodoc
```

If you use PowerShell on Windows, add quotes :

```bash
npm install -g "@compodoc/compodoc"
```

# Local installation

```bash
npm install --save-dev @compodoc/compodoc
```

Define a script task for it in your package.json :

```bash
"scripts": {
  "compodoc": "./node_modules/.bin/compodoc -p src/tsconfig.json"
}
```

and run it like a normal npm script :

```bash
npm run compodoc
```

See [usage](./usage.html) for more details.

# Node.js versions

Compodoc is tested with only LTS versions : v8.9.1, v6.12.0 & v4.8.6

# Angular-CLI

Compodoc supports last Angular-CLI version : 1.5

Just run Compodoc in a fresh or existing project.

# Global installation

Install from npm :

```bash
npm install -g @compodoc/compodoc
```

If you use PowerShell on Windows, add quotes :

```bash
npm install -g "@compodoc/compodoc"
```

# Local installation

```bash
npm install --save-dev @compodoc/compodoc
```

Define a script task for it in your package.json :

```bash
"scripts": {
  "compodoc": "./node_modules/.bin/compodoc -p src/tsconfig.json"
}
```

and run it like a normal npm script :

```bash
npm run compodoc
```

See [usage](./usage.html) for more details.

Update Node.js versions and cli
Update Node.js versions and cli
