better-docs

better-docs copied to clipboard

Document @private methods

4

Thank you for this beautiful work! I'm trying to document private methods so I put ```"access": "all"``` and also tried ```"private": true``` in my jsdoc.jon file, in the ```"opts"```option. It...

benoitlahoz

This is so awesome!!! _THIS_ is the proper direction TypeScript documentation should have gone in. The other solutions like `TSDoc`, `typedoc`, etc, are incompatible with the original `jsdoc` and hence...

trusktr

First of all, thanks for the amazing templating for JSDoc. I am currently implementing better-docs in my project to pitch for my team, but I want to do some minor...

xLonelyPlayer

Error 404 - entry.js not generated when not using @component

3

I am using better-docs and it is doing a great job. I've noticed that my documentation is missing the ```build/entry.js``` file since I am not using any ```@component``` tags in...

TheoGoudout

@lifecycle, template options, react native @component

1

Added several new template options and a 'lifecycle' plugin to make the generated documentation much more manageable - added `isReactNative` template setting - Doesn't use the `entry.js` file created in...

sonyboy232

How to document complex prop-types and display the correct data type?

2

When I try to document the following prop: ``` /** * Form fields inputs */ inputs: PropTypes.arrayOf( PropTypes.shape({ id: PropTypes.string, name: PropTypes.string, placeholder: PropTypes.string, type: PropTypes.string, data: PropTypes.arrayOf( PropTypes.shape({ value:...

mowagih96

How to render Components brought from Component Library (Ex: material-ui react)

1

This library seems great so far, but I have my own components that are built using Material UI React's component library and I was wondering how do I render those...

ethanny2

Is there a way to have markdown checkbox being rendered as HTML checkbox elements? similar to how github would handle this ? ``` - [ ] test ``` - [...

pietrop

Example section doesn't render anything.

4

After trying various settings I can't get the preview section to show up in the documentation. Libraries Versions: "better-docs": "^2.3.2" "react": "^17.0.1" My jsdoc config file looks like: ` {...

santiagorodriguez24

`iframeRef.current` has no object named `node`. This triggers an error in `computHeight()` function in `react-wrapper.js`

akojimsg