Documentar y desarrollar componentes React con MDX y Next.js

https://mdx-docs.now.sh/
npm init docs Para crear un nuevo sitio de documentación, ejecute npm init docs y siga las indicaciones. Una vez que se haya generado la aplicación, consulte el ReadMe.md para obtener más documentación.
Para agregar documentos MDX a una aplicación Next.js existente, consulte los documentos de configuración personalizados.
MDX le permite mezclar la reducción con JSX en línea para representar los componentes React. Escriba Markdown como lo haría normalmente y use la sintaxis de importación de ES para usar componentes personalizados en su documento.
import { Box } from ' grid-styled '
# Hello MDX!
< Box
p = { 3 }
bg = ' tomato ' >
This will render as a component
</ Box > MDX Docs tiene componentes incorporados para representar bloques de código vallados JSX como vistas previas en vivo con código editable, alimentado por React-Live. Para hacer un renderizado de bloque de código como un ejemplo editable, use el atributo de lenguaje .jsx (tenga en cuenta el prefijo . ).
Live code example:
``` .jsx
< button > Beep < / button >
``` Para agregar componentes al alcance de su uso en los ejemplos de código en vivo, pase un objeto components al componente Layout .
// example components
import React from 'react'
export default {
Box : props => (
< div
{ ... props }
style = { {
padding : '32px' ,
backgroundColor : 'tomato'
} }
/>
)
} // example _app.js
< Layout
{ ... this . props }
components = { components } >
< Layout . Main >
< Component { ... page } />
</ Layout . Main >
</ Layout > El objeto components también puede incluir componentes para representar los elementos HTML en MDX.
MDX-GO, Compositor X0, MDX-Deck, Live-Doc, Doctor Mark, Docz
Next.js, mdx, react-live
Licencia de MIT