mdx docs Download - mdx docs Download do código fonte

mdx docs

Código-Fonte de IA

1.0.0

Baixar

MDX Docs

Documente e desenvolva componentes do React com MDX e Next.js

https://mdx-docs.now.sh/

npm init docs

Crie documentação com Markdown
⚛️ Importar e usar componentes do React
API baseada em componentes
Exemplos de código ao vivo
? Temas personalizáveis
▲ construído para o próximo.js

Começando

Para criar um novo site de documentação, execute npm init docs e siga os prompts. Depois que o aplicativo for gerado, consulte o readme.md para obter mais documentação.

Para adicionar documentos MDX a um aplicativo Next.js existente, consulte os documentos de configuração personalizados.

Usando o MDX

O MDX permite misturar o Markdown com o JSX embutido para renderizar componentes do React. Escreva o Markdown como você normalmente faria e use ES importar sintaxe para usar componentes personalizados em seu documento.

 import { Box } from ' grid-styled '

# Hello MDX!

< Box
  p = { 3 }
  bg = ' tomato ' >
  This will render as a component
</ Box >

Código ao vivo

O MDX DOCS possui componentes internos para renderizar blocos de código cercados JSX como visualizações ao vivo com código editável, alimentado pelo React-Live. Para fazer uma renderização de bloco de código como um exemplo editável, use o atributo .jsx Language (observe o prefixo . ).

Live code example:

``` .jsx
< button > Beep < / button >
```

Escopo dos componentes

Para adicionar componentes ao escopo para uso nos exemplos de código ao vivo, passe um objeto components para o 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 >