I cloned the repository:
and based on it I created the following repository:
Check Demo here:
https://napolev.github.io/web-components/
On top of it I created 2 custom web-components
:
{ <thumb-01-product />
, <thumb-02-product />
}
Here is the usage for each of them:
<thumb-01-product
thumb="https://placeimg.com/900/400/1/1"
name="PICTURE 01"
button-text="PURCHASE"
></thumb-01-product>
<thumb-02-product
thumb="https://placeimg.com/215/170/2/1"
description="Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum is simply dummy text of the printing and typesetting industry."
button-text="READ MORE"
url="https://www.google.com/search?num=5&q=image+1"
target="_blank"
></thumb-02-product>
Now I want to create an API documentation for it. Then I’m wondering what’s the best tool for that?
I tried the Compodoc
documentaion tool:
https://compodoc.app/guides/getting-started.html
I executed the following command:
$ npm run compodoc
but I got like an empty API Doc as you can see here:
https://napolev.github.io/web-components/documentation/
where my two web components were ignored. Here you have each of them:
Do you have any suggestion for this? I mean either, how to make Compodoc
generate the API documentation properly or suggest me another tool to generate it?
Thanks!