better-docs

better-docs copied to clipboard

Getting error while using template with react and jsdoc

1

Getting the following error whenever i tried to add `"template": "node_modules/better-docs"` in **opts** of my jsdoc.conf.json [error.txt](https://github.com/SoftwareBrothers/better-docs/files/5709745/error.txt) Here is the current config i am using **jsdoc.conf.json** [jsdoc.conf.txt](https://github.com/SoftwareBrothers/better-docs/files/5709756/jsdoc.conf.txt) i also tried...

0sikarwar

Hi there, tanks for the great JSDoc plugin! When I click on the links in the methods section in the right sidebar, the scroll is too high. 

RilDev

It would be helpful if the navigation index on the right indicated if a method or member was Static or Async. This information is provided when looking at the definition,...

Digicrat

So it looks like when using @subcategory, it only works if you are using @component along with it. It would be nice if @subcategory would work without this requirement.

lr001dev

Assets Files Not Copied Into Generated Docs Folder

4

I'm trying to add a logo and a custom stylesheet on the JSDoc build configs, but the files are not copied over to the generated `docs` directory. I placed my...

RilDev

Is there a way to enable the search through the docs? And what about making main menu items like GLOBALS, CLASSES etc collapsable?

mdellanave

Not displaying React propTypes isRequired in the document

1

Tried the sample react component with proptypes. The example gets generated fine but required is 'No' even if isRequired is added to proptype. `/** * Some documented component * *...

smarajitdasgupta

I think it would be great for the preview feature to support Polymer and Lit Elements. I am aware of the contributing guidelines for this project, but if this feature...

oliveryasuna

High vulnerability issue

4

Better-docs is using outdated version of `vue-docgen-api`, that has known high severity vulnerability. This issue cannot be automatically resolved with `npm audit fix`.

tomas-hartman

TypeError: Cannot read property 'name' of undefined

6

Hi, When I pass default props in React functional component like in this example: ```js /** * Component renders input field of profile image. * * @name ProfileImage * @component...

kszymczycha