Made in DeveloperHub
DeveloperHub fue diseñado para unificar la vista entre el editor y la versión publicada.
No es necesario previsualizar tu documentación. El editor ya te muestra la misma vista que verán los lectores de tu documentación 😉
¡¿En qué estaba pensando antes?!
Si realmente quieres previsualizarla, puedes verla en vivo publicándola.
Estrategia de URL
La URL, que es el enlace que ves en tu navegador, define qué proyecto, versión y sección (documentación o referencia de API) se cargan.
Este es un resumen de cómo cargamos los recursos mediante URL:
URL | Resultado |
|---|---|
| Carga la página predeterminada de la documentación especificada, o la referencia de API especificada en la versión predeterminada. |
| Carga la página en la documentación especificada en la versión predeterminada |
| Carga la página predeterminada de la documentación especificada, o la referencia de API especificada en la versión especificada |
| Carga la página especificada en la documentación especificada en la versión especificada |
| Carga la página de inicio si está habilitada, o la página predeterminada en la sección predeterminada de la versión predeterminada |
Las siguientes son URL obsoletas que ya no debes usar; sin embargo, ahora se redirigen por compatibilidad con versiones anteriores:
URL | Redirigida a |
|---|---|
|
|
|
|
|
|
|
|
|
|
Cualquier otra forma de enlace cargará la página predeterminada.
Ten en cuenta que puedes añadir una ruta base si alojas bajo tu propio sitio web existente; las reglas anteriores seguirían aplicándose, pero se añadiría una ruta base justo después de <project>. Por ejemplo, en lugar de https://<project>/<version>/<documentation>/<page>, el enlace sería https://<project>/<base-path>/<version>/<documentation>/<page>.
Optimizado para impresión
Nuestras páginas están optimizadas para impresión (especialmente para papel de tamaño A4). Recomendamos usar el diseño amplio de documentación al imprimir, e imprimir siempre desde el sitio de documentación publicado (no desde el editor). Si eres cliente empresarial, también puedes exportar una versión completa como PDF.
Modo incrustado
Los sitios de DeveloperHub se pueden incrustar usando iframe según sea necesario. Esto es especialmente útil si deseas crear un widget de documentación para que tu lector pueda seguir las instrucciones sin salir de sus pestañas.
Hay dos tipos de modo incrustado:
Minimal: oculta la navegación superior, el pie de página, el índice y la tabla de contenidos. El modo es
embed.Normal: oculta solo la navegación superior y el pie de página. El modo es
embed_full.
Los modos minimal y normal son iguales cuando el ancho de la ventana es pequeño, ya que el índice y la tabla de contenidos se ocultan de forma predeterminada en ese caso.
El modo incrustado se habilita añadiendo ?mode=embed o ?mode=embed_full a cualquier URL de DeveloperHub (excepto las páginas de inicio). Por ejemplo, si quieres mostrar a tus usuarios una página bajo https://dev.company.io/ios/getting-started, puedes cargar un iframe con src="https://dev.company.io/ios/getting-started?mode=embed"
Aquí tienes una vista previa:
