Comece em três passos
Coloque seu site de documentação em execução localmente e faça sua primeira personalização.Etapa 1: Ambiente local
Clone o repositório
Clone o repositório
No onboarding você criou um repositório no GitHub com o conteúdo, se ainda não tinha um. O link está no seu painel.Para clonar o repositório e pré-visualizar alterações, siga o guia Clonar um repositório na documentação do GitHub.
Inicie o servidor de pré-visualização
Inicie o servidor de pré-visualização
- Instale a CLI do Mintlify:
npm i -g mint - Entre no diretório da documentação e execute:
mint dev - Abra
http://localhost:3000para ver a documentação ao vivo.
Etapa 2: Implante suas alterações
Instale o app do GitHub
Instale o app do GitHub
Instale o app Mintlify para GitHub nas configurações.O app implanta automaticamente as alterações no seu site de documentação.
Atualize nome e cores
Atualize nome e cores
Como primeira alteração, atualize o nome e as cores do site.
- Abra
docs.jsonno editor. - Altere o campo
"name"para o nome do seu projeto. - Atualize
"colors"para combinar com sua marca. - Salve e confira em
http://localhost:3000.
Etapa 3: Publicar
Publique sua documentação
Publique sua documentação
- Faça commit e push das alterações.
- A documentação será atualizada e ficará no ar em instantes.
Próximos passos
Com a documentação rodando, explore estes recursos:Escrever conteúdo
Aprenda a sintaxe MDX e comece a escrever.
Personalizar estilo
Deixe a documentação alinhada à sua marca.
Adicionar exemplos de código
Inclua blocos de código com destaque de sintaxe.
Documentação de API
Gere documentação de API a partir de especificações OpenAPI.
Precisa de ajuda? Veja a documentação completa ou entre na comunidade.