Ir para o conteúdo
Documentação

Publique o seu projeto com um URL público

assista a isto 

O que irá aprender

  • Publicar todo o seu projeto num URL ativo e partilhável com apenas um clique.
  • Personalizar a aparência da sua documentação, incluindo o slug do URL, a secção de destaque (hero), temas e cores.
  • Configurar definições para a indexação em motores de busca e navegação do site.
  • Atualizar facilmente a sua documentação ativa após editar os seus artigos.

Publicar a sua documentação

Assim que a sua base de conhecimento estiver pronta, pode torná-la acessível aos seus utilizadores publicando-a num URL público. Este processo é simples e pode ser feito em poucos passos.

  1. Clique no menu de três pontos junto ao nome do seu projeto para abrir as Definições do Projeto.
  2. Na janela de definições, a secção Publicação é apresentada por predefinição.
  3. Clique no botão Publicar Documentação para colocar o seu site online.
Documentation image

Após a publicação, o estado mudará para Publicado e verá opções para Ver Site Ativo ou Anular Publicação.

Personalizar o seu site público

O Hinto oferece várias opções para personalizar o aspeto da sua documentação publicada, garantindo que esta se alinha com a sua marca. Estas definições encontram-se todas na janela de Definições do Projeto.

  • Geral: Personalize o seu Slug de URL para criar uma ligação com a sua marca. Também pode ativar ou desativar a Indexação em Motores de Busca para controlar se o seu site aparece nos resultados de pesquisa.
  • Secção de Destaque (Hero): Edite o Título, Subtítulo e Descrição que aparecem no topo da página inicial da sua documentação.
  • Temas e Cores: Escolha entre os modos claro e escuro, carregue logótipos personalizados, defina as cores primária e secundária da sua marca e selecione entre várias fontes.
  • Navegação: Adicione ligações personalizadas ao cabeçalho e rodapé do seu site para encaminhar os utilizadores para outros recursos.
Documentation image

Atualizar a sua documentação ativa

À medida que faz alterações aos seus artigos, precisará de enviar essas atualizações para o seu site ativo. O Hinto torna este processo simples.

  1. Após editar um artigo, clique no botão Guardar alterações no canto superior direito.
  2. Um botão Republicar aparecerá na barra lateral esquerda sob a ligação publicada.
  3. Clique em Republicar para atualizar a sua documentação ativa com as alterações mais recentes.
Documentation image

Agora experimente

Aplique o que aprendeu publicando e personalizando o seu próprio projeto.

  1. Abra um dos seus projetos e navegue até às Definições do Projeto.
  2. Clique em Publicar Documentação.
  3. No separador Temas e Cores, escolha uma nova Cor Primária que combine com a sua marca.
  4. Clique em Ver Site Ativo para ver a sua documentação personalizada.
  5. Regresse ao editor, faça uma pequena alteração num artigo, guarde-a e clique no botão Republicar para ver a sua atualização entrar em vigor.

Resumo

Nesta lição, aprendeu a publicar a sua base de conhecimento e a disponibilizá-la ao mundo. Também explorou as poderosas opções de personalização que lhe permitem adaptar o URL, a aparência e a navegação do seu site público para criar uma experiência profissional e alinhada com a sua marca para os seus utilizadores. Por fim, viu como é fácil manter a sua documentação atualizada com a funcionalidade de republicação de um clique.

Relacionado