Interface do editor web da Mintlify no modo claro O editor web é uma interface visual para criar, editar e revisar documentação diretamente no seu navegador.
  • Edição visual: Faça alterações na sua documentação usando um editor WYSIWYG (what you see is what you get) que mostra como seu conteúdo ficará quando publicado.
  • Sincronização com o Git: Todas as alterações são sincronizadas automaticamente com o seu repositório Git para manter o controle de versão.
  • Colaboração em equipe: Várias pessoas podem trabalhar na documentação simultaneamente.
  • Integração de componentes: Adicione callouts, blocos de código e outros componentes com comandos de barra (/).
  • Sem necessidade de configuração: Comece a escrever imediatamente no seu painel.

​
Fluxo de trabalho no Editor web

Veja como você normalmente trabalhará no editor web:
1

Choose your branch

Crie uma branch ou faça alterações diretamente na branch de implantação. Recomendamos criar uma branch para poder pré-visualizar suas alterações antes de irem ao ar.
2

Open your file

Navegue até um arquivo existente na barra lateral ou crie um novo usando o explorador de arquivos.
3

Edit your content

Faça alterações no editor web. Experimente alternar entre o modo visual e o modo Markdown usando a chave no canto superior direito para ver qual prefere.
4

Preview your changes

O modo visual mostra como suas alterações aparecerão no site em produção. Use-o para verificar se está tudo correto.
5

Publish your changes

Se estiver trabalhando na branch de implantação, publique suas alterações diretamente do editor web. Em outras branches, crie um pull request para revisão antes de publicar.

​
Modos do editor

O Editor web tem dois modos para atender a diferentes preferências e necessidades de edição. Use o botão de alternância no canto superior direito da barra de ferramentas do editor para mudar entre os modos de edição.
Ícones do botão de alternância de modo destacados no Editor web.

​
Modo visual

O modo visual oferece uma experiência WYSIWYG em que as alterações feitas no editor são exatamente as que serão publicadas no seu site de documentação. Esse modo é ideal quando você quer ver, em tempo real, como suas alterações vão ficar. Pressione ”/” para abrir o menu de componentes e adicionar conteúdo com estilo, avisos, trechos de código ou outros componentes.
Modo de edição visual no Editor web da Mintlify

​
Modo Markdown

O modo Markdown oferece acesso direto ao código MDX subjacente da sua documentação. Esse modo é ideal quando você precisa de controle preciso sobre as propriedades dos componentes ou prefere escrever na sintaxe Markdown.
Modo Markdown no Editor web da Mintlify

​
Próximos passos