Ir al contenido
Documentación

Publica tu proyecto con una URL pública

mira esto 

Qué aprenderás

  • Publicar todo tu proyecto en una URL en vivo y compartible con un solo clic.
  • Personalizar la apariencia de tu documentación, incluyendo el slug de la URL, la sección principal, los temas y los colores.
  • Configurar los ajustes para la indexación en motores de búsqueda y la navegación del sitio.
  • Actualizar tu documentación en vivo fácilmente después de realizar ediciones en tus artículos.

Cómo publicar tu documentación

Una vez que tu base de conocimientos esté lista, puedes hacer que sea accesible para tus usuarios publicándola en una URL pública. Este proceso es sencillo y se puede realizar en solo unos pocos pasos.

  1. Haz clic en el menú de tres puntos junto al nombre de tu proyecto para abrir la Configuración del proyecto.
  2. En la ventana modal de configuración, la sección de Publicación aparece de forma predeterminada.
  3. Haz clic en el botón Publicar documentación para poner tu sitio en línea.
Documentation image

Después de publicar, el estado cambiará a Publicado y verás opciones para Ver sitio en vivo o Despublicar.

Cómo personalizar tu sitio público

Hinto ofrece una variedad de opciones para personalizar el aspecto de tu documentación publicada, asegurando que se alinee con tu marca. Todos estos ajustes se encuentran dentro de la ventana modal de Configuración del proyecto.

  • General: Personaliza tu Slug de URL para crear un enlace con tu marca. También puedes activar o desactivar la Indexación en motores de búsqueda para controlar si tu sitio aparece en los resultados de búsqueda.
  • Sección principal: Edita el Título, el Subtítulo y la Descripción que aparecen en la parte superior de la página de inicio de tu documentación.
  • Temas y colores: Elige entre modos claro y oscuro, sube logotipos personalizados, establece los colores primario y secundario de tu marca y selecciona entre una variedad de fuentes.
  • Navegación: Agrega enlaces personalizados al encabezado y al pie de página de tu sitio para dirigir a los usuarios a otros recursos.
Documentation image

Cómo actualizar tu documentación en vivo

A medida que realices cambios en tus artículos, deberás enviar esas actualizaciones a tu sitio en vivo. Hinto hace que este proceso sea sencillo.

  1. Después de editar un artículo, haz clic en el botón Guardar cambios en la parte superior derecha.
  2. Aparecerá un botón de Republicar en la barra lateral izquierda debajo del enlace publicado.
  3. Haz clic en Republicar para actualizar tu documentación en vivo con los cambios más recientes.
Documentation image

Ahora inténtalo tú

Aplica lo que has aprendido publicando y personalizando tu propio proyecto.

  1. Abre uno de tus proyectos y navega a Configuración del proyecto.
  2. Haz clic en Publicar documentación.
  3. En la pestaña Temas y colores, elige un nuevo Color primario que coincida con tu marca.
  4. Haz clic en Ver sitio en vivo para ver tu documentación personalizada.
  5. Regresa al editor, realiza un pequeño cambio en cualquier artículo, guárdalo y haz clic en el botón Republicar para ver cómo tu actualización se publica.

Resumen

En esta lección, aprendiste cómo publicar tu base de conocimientos y hacerla disponible para todo el mundo. También exploraste las potentes opciones de personalización que te permiten adaptar la URL, la apariencia y la navegación de tu sitio público para crear una experiencia profesional y coherente con tu marca para tus usuarios. Finalmente, viste lo fácil que es mantener tu documentación actualizada con la función de republicación de un solo clic.

Relacionado