O que writing-docs faz?
Guias para escrever e editar a documentação do Remotion. Use ao adicionar páginas de documentação, editar arquivos MDX em packages/docs ou escrever conteúdo de documentação.
Como usar
- Navegue até o diretório
packages/docs. - Crie ou edite arquivos
.mdxconforme necessário. - Siga as convenções de estilo e formatação descritas abaixo.
Convenções
- Use títulos claros e hierarquia adequada (
#,##,###). - Inclua exemplos de código relevantes usando blocos de código com a linguagem especificada.
- Verifique se todos os links internos e externos estão funcionando.
- Mantenha a consistência com o tom e a voz da documentação existente.
Exemplo
# Título da Página
Descrição introdutória.
## Seção
Conteúdo da seção.
```tsx
import {useCurrentFrame} from 'remotion';
const MeuComponente = () => {
const frame = useCurrentFrame();
return <div>{frame}</div>;
};
## Referências
- [Documentação oficial do Remotion](https://remotion.dev/docs)
- [Guia MDX](https://mdxjs.com/)