Componentes
Reusable snippets
Um dos princípios fundamentais do desenvolvimento de software é DRY (Don’t Repeat Yourself), que também se aplica à documentação. Se você se encontrar repetindo o mesmo conteúdo em vários lugares, deve criar um snippet personalizado para manter seu conteúdo sincronizado.
Criando um snippet personalizado
Pré-condição: Você deve criar seu arquivo de snippet no diretóriosnippets
para que a importação funcione.
Qualquer página no diretóriosnippets
será tratada como um snippet e não será renderizada como uma página independente. Se você quiser criar uma página independente a partir do snippet, importe o snippet para outro arquivo e chame-o como um componente.
Exportação padrão
- Adicione conteúdo ao seu arquivo de snippet que você deseja reutilizar. Opcionalmente, você pode adicionar variáveis que podem ser preenchidas via props quando você importar o snippet. Neste exemplo, nossa variável é word.
snippets/my-snippet.mdx
- Importe o snippet para o seu arquivo de destino.
destination-file.mdx
Exportando com variáveis
- Opcionalmente, você pode adicionar variáveis que podem ser preenchidas via props quando você importar o snippet. Neste exemplo, nossa variável é word.
snippets/my-snippet.mdx
- Importe o snippet para o seu arquivo de destino com a variável. A propriedade será preenchida com base na sua especificação.
destination-file.mdx
Variáveis reutilizáveis
- Exporte uma variável do seu arquivo de snippet:
snippets/path/to/custom-variables.mdx
- Importe o snippet do seu arquivo de destino e use a variável:
destination-file.mdx