Skip to content

Commit

Permalink
docs(storybook): update image link (#14230)
Browse files Browse the repository at this point in the history
closed #14178
  • Loading branch information
mandarini committed Jan 9, 2023
1 parent 13a61e9 commit ea34f25
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
Expand Up @@ -26,11 +26,11 @@ Let's take for example an Angular component - a button - that has an `@Input` fo

This comment would result in the following documentation in Compodoc:

![Button size `@Input` generated documentation](/shared/guides/storybook/button-size-input.png)
![Button size `@Input` generated documentation](/shared/packages/storybook/button-size-input.png)

If we add a description and a default value to each of our component `@Input`s, we will end up with a full documentation page. See a full example of the button component [here](https://github.com/nrwl/nx-recipes/tree/main/storybook-compodoc-angular/apps/web/src/app/butn/butn.component.ts). The generated documentation of this example will look like this:

![Generated Docs page for the Button](/shared/guides/storybook/button-docs.png)
![Generated Docs page for the Button](/shared/packages/storybook/button-docs.png)

When you run Compodoc, it will generate a `documentation.json` file. Storybook will then use that file to render the documentation in the `Docs` tab.

Expand Down
4 changes: 2 additions & 2 deletions docs/shared/packages/storybook/angular-storybook-compodoc.md
Expand Up @@ -26,11 +26,11 @@ Let's take for example an Angular component - a button - that has an `@Input` fo

This comment would result in the following documentation in Compodoc:

![Button size `@Input` generated documentation](/shared/guides/storybook/button-size-input.png)
![Button size `@Input` generated documentation](/shared/packages/storybook/button-size-input.png)

If we add a description and a default value to each of our component `@Input`s, we will end up with a full documentation page. See a full example of the button component [here](https://github.com/nrwl/nx-recipes/tree/main/storybook-compodoc-angular/apps/web/src/app/butn/butn.component.ts). The generated documentation of this example will look like this:

![Generated Docs page for the Button](/shared/guides/storybook/button-docs.png)
![Generated Docs page for the Button](/shared/packages/storybook/button-docs.png)

When you run Compodoc, it will generate a `documentation.json` file. Storybook will then use that file to render the documentation in the `Docs` tab.

Expand Down

1 comment on commit ea34f25

@vercel
Copy link

@vercel vercel bot commented on ea34f25 Jan 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-nrwl.vercel.app
nx-dev-git-master-nrwl.vercel.app
nx-five.vercel.app
nx.dev

Please sign in to comment.