Quickstart
Esta guía de inicio rápido lo guiará a través del proceso de configuración e implementación de su sitio de documentación en solo unos minutos.
Al final de esta guía, tendrá un sitio de documentación en vivo que está listo para personalizar y expandir.
Requisitos previos: Antes de comenzar, asegúrese de crear una cuenta y completar el proceso de incorporación.
Primeros pasos
Una vez que haya completado el proceso de incorporación, su sitio de documentación se implementará automáticamente en una URL única con el siguiente formato.
Puede encontrar su URL en la página de Resumen del panel de control.
Esta URL está disponible instantáneamente y se actualizará cada vez que realice cambios en su documentación. Es perfecta para pruebas y para compartir con su equipo durante el desarrollo.
Instale la aplicación de GitHub
Mintlify proporciona una aplicación de GitHub que automatiza el proceso de implementación cuando envía cambios a su repositorio.
Puede instalar la aplicación de GitHub siguiendo las instrucciones de la lista de verificación de incorporación o desde su panel de control.
- Navegue a Configuración en su panel de control de Mintlify.
- Seleccione Aplicación de GitHub en la barra lateral.
- Seleccione Instalar aplicación de GitHub. Esto abrirá una nueva pestaña en la página de instalación de la aplicación de GitHub.
- Seleccione la organización o cuenta de usuario donde desea instalar la aplicación. Luego seleccione los repositorios que desea conectar.
Recuerde actualizar los permisos de la aplicación de GitHub si mueve la documentación a un repositorio diferente.
Autorice su cuenta de GitHub
- Navegue a Configuración en su panel de control de Mintlify.
- Seleccione Mi perfil en la barra lateral.
- Seleccione Autorizar cuenta de GitHub. Esto abrirá una nueva pestaña en la página de autorización de GitHub.
Es posible que necesite un administrador de su organización de GitHub para autorizar su cuenta dependiendo de la configuración de su organización.
Flujos de trabajo de edición
Mintlify ofrece dos flujos de trabajo diferentes para crear y mantener su documentación.
Flujo de trabajo basado en código
Para desarrolladores que prefieren trabajar con sus herramientas existentes. Haga clic para ir a la sección.
Flujo de trabajo del editor web
Para aquellos que prefieren una interfaz visual. Haga clic para ir a la sección.
Flujo de trabajo basado en código
El flujo de trabajo basado en código se integra con su entorno de desarrollo existente y repositorios Git, haciéndolo ideal para equipos técnicos que desean gestionar la documentación junto con su código.
Instale la CLI
Para trabajar localmente con su documentación, instale la Interfaz de Línea de Comandos (CLI), llamada mint, ejecutando el siguiente comando en su terminal:
Necesita tener instalada la versión 19 o superior de Node.js en su máquina. Si encuentra problemas de instalación, consulte la guía de solución de problemas.
Edite la documentación
Ahora que tu entorno está configurado, puedes comenzar a editar tus archivos de documentación. Como ejemplo, vamos a actualizar el título de la página de introducción:
Abre el repositorio creado durante la incorporación, encuentra elintroduction.mdxarchivo, y busca la parte superior del archivo, que debería verse así:
Actualiza el campotitlea"Hello World".
Vista previa de los cambios
Para previsualizar los cambios localmente, ejecuta el siguiente comando.
Tu vista previa estará disponible enlocalhost:3000.
Subir los cambios
Cuando estés listo para publicar tus cambios, simplemente súbelos a tu repositorio.
Mintlify detectará automáticamente los cambios, construirá tu documentación y desplegará las actualizaciones en tu sitio. Puedes monitorear el estado del despliegue en el historial de commits de tu repositorio de GitHub o en eldashboard.
Una vez que el despliegue esté completo, tu última actualización estará disponible en<your-project-name>.mintlify.app.
Saltar a añadir un dominio personalizado
Opcionalmente, salta el flujo de trabajo del editor web y pasa directamente a añadir un dominio personalizado.
Flujo de trabajo del editor web
El flujo de trabajo del editor web proporciona una interfaz WYSIWYG (lo que ves es lo que obtienes) para crear y editar documentación. Es ideal para personas que quieren trabajar en su navegador web sin herramientas de desarrollo local adicionales.
Acceder al editor web
- Inicia sesión en tuMintlify Dashboard.
- SeleccionaEditoren la barra lateral izquierda.
Si no has instalado la aplicación de GitHub, se te pedirá que lo hagas al abrir el editor web.
Editar la documentación
En el editor web, puedes navegar por tus archivos de documentación en la barra lateral. Vamos a actualizar la página de introducción.
Encuentra y haz clic enintroduction.mdxen el explorador de archivos.
Luego, en el editor visual, actualiza el campo de título a “Hello World”.
El editor proporciona un rico conjunto de herramientas de formato y componentes. Accede a ellos escribiendo ”/” en el editor para abrir el menú de comandos.
Publicar tus cambios
Cuando estés satisfecho con tus ediciones, haz clic en el botónPublishen la esquina superior derecha.
Tus cambios se desplegarán inmediatamente en tu sitio de documentación.
Para más detalles sobre el uso del editor web, incluyendo funciones avanzadas como comandos de barra y carga de imágenes, consulta nuestradocumentación del Editor Web.
Añadir un dominio personalizado
Aunque tu subdominio<your-project-name>.mintlify.appfunciona bien para pruebas y desarrollo, la mayoría de los equipos prefieren usar un dominio personalizado para la documentación en producción.
Para añadir un dominio personalizado, ve aSettings>Custom Domaindesde el dashboard.
Ingresa tu dominio (por ejemplo, docs.tuempresa.com) y sigue las instrucciones proporcionadas para configurar los ajustes DNS con tu proveedor de dominio.
Los cambios de DNS pueden tardar hasta 48 horas en propagarse, aunque a menudo se completan mucho antes.
Próximos pasos
¡Felicidades! Has desplegado con éxito tu sitio de documentación con Mintlify. Aquí tienes algunos pasos sugeridos para mejorar tu documentación:
Personalizar tu tema
Aprende cómo personalizar colores, fuentes y la apariencia general de tu sitio de documentación.
Organizar la navegación
Estructura tu documentación con una navegación intuitiva para ayudar a los usuarios a encontrar lo que necesitan.
Añadir componentes interactivos
Mejora tu documentación con componentes interactivos como acordeones, pestañas y ejemplos de código.
Configurar referencias de API
Crea referencias de API interactivas con especificaciones OpenAPI y AsyncAPI.
Solución de problemas
Si encuentras algún problema durante el proceso de configuración, consulta nuestras soluciones comunes de resolución de problemas:
¿Necesitas más ayuda?Contacta a nuestro equipo de soporte.