javascript - helmet - ¿Cómo hacer documentación en ReactJS?

react render (5)

Documentamos nuestra biblioteca de componentes React utilizando React Styleguidist .

Se analizará su código con las siguientes características:

generar documentos API / props a partir de los PropTypes que defina.
Cree la documentación de ejemplos editables en vivo que permite a las personas copiar y copiar fragmentos de forma sencilla.
Es bastante bien configurable y tiene una recarga en caliente para lograr documentos internos.

Funciona mediante la creación de una aplicación web a través de Webpack, que puede usar localmente o alojar en algún lugar para todos sus desarrolladores.

Para nosotros, funciona bastante bien y lo mejoran con el tiempo.

Edición: Se utiliza react-docgen bajo el capó.

Tengo un requisito para crear el archivo doc de cada uno de los componentes que definimos en nuestra aplicación reactjs. Estoy buscando el npm que podamos usar para crear el documento de cualquier extensión, para que pueda extraer el código, comente todo mi componente y cambiarlo al documento de cualquier extensión. ¿Cómo puedo hacer eso por favor ayudarme? Mi pregunta es diferente de la otra pregunta encontrada con respecto a jsdoc, porque estoy buscando la documentación en reactjs usando jsdoc.

Finalmente encontré la solución, primero vaya a este enlace y lea el documento correctamente: - Leer el documento ahora, siga los siguientes pasos: -

Abra su línea de comandos

Instale el JSDoc globalmente mediante el comando: npm install jsdoc -g

Ahora vaya a la ruta de la carpeta de su proyecto y ejecute el comando: jsdoc src -r -d docs

El comando anterior creará el documento en la carpeta de documentos del directorio de su proyecto.

He escrito un pequeño envoltorio para el react-docgen que hace que sea un poco más fácil trabajar con eso. Exporta un archivo de rebajas para todos los componentes en la carpeta pasada.

Verifique el proyecto https://github.com/LaustAxelsen/wilster-doc

Prueba este paquete que tiene ejemplos para que entiendas.

Proporciona una implementación predeterminada para los componentes React definidos a través de React.createClass, definiciones de clase ES2015 o funciones (componentes sin estado). Estas definiciones de componentes deben seguir ciertas pautas para poder ser analizables (ver más abajo para más información).

https://www.npmjs.com/package/@rtsao/react-docgen

Tenemos un montón de librerías de componentes de reacción y utilizamos react-showroom

Permite escribir documentación en markdown y tener sandbox. Una gran ventaja de esto: puede comenzar un nuevo proyecto en dos minutos con un webpack, babel, pelusa, etc. ya configurado.

Muy recomendable intentarlo.