From 7c9cbf1bd1a747ee5a7668bf945d7a3a3701b7bb Mon Sep 17 00:00:00 2001 From: Tobias Wittwer Date: Sat, 2 May 2020 17:27:39 +0200 Subject: [PATCH] docs(compodoc): add kudos to @compodoc --- libs/compodoc/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/libs/compodoc/README.md b/libs/compodoc/README.md index baf74c2..410988f 100644 --- a/libs/compodoc/README.md +++ b/libs/compodoc/README.md @@ -1,10 +1,11 @@ -# compodoc +# Compodoc (Nx Plugin) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) -> Nx Plugin to integrate the generation of documentation with [Compodoc](https://compodoc.app/) in the [Nx workflow](https://nx.dev/angular). +> Nx Plugin to integrate the generation of documentation with [Compodoc](https://compodoc.app/) in the [Nx workflow](https://nx.dev/angular). +> NOTE: The whole generation part is done by [@compodoc/compodoc](https://github.com/compodoc/compodoc), this is just a wrapper plugin for Nx workspaces. - [Installation](#installation) - [Usage](#usage)