GitHub Docs proporciona varias maneras de acceder al contenido de la documentación mediante programación. Puede obtener artículos individuales en Markdown, listar todas las páginas disponibles, buscar en toda la documentación o indicar a los agentes de IA el archivo llms.txt para el descubrimiento de contenido.
Punto de conexión del artículo
El punto de conexión del artículo devuelve el contenido y los metadatos de Markdown de cualquier GitHub Docs página. Admite todos los tipos de página, incluidos los artículos estándar, las páginas de referencia de la API REST, las páginas de referencia de GraphQL y las páginas de aterrizaje.
El punto de conexión del artículo acepta el siguiente parámetro de consulta:
pathname(obligatorio): ruta de acceso del artículo, incluido un prefijo de idioma como/en/o/ja/.- Por ejemplo:
/en/get-started/start-your-journey/about-github-and-git.
- Por ejemplo:
Además, GET /api/article y GET /api/article/body acepte el siguiente parámetro de consulta opcional:
apiVersion: para las páginas de referencia de la API REST, especifica qué versión de API se va a usar. Se establece de forma predeterminada en la última versión.
Obtención del contenido del artículo
GET https://docs.github.com/api/article/body devuelve el contenido completo del artículo como Markdown.
curl "https://docs.github.com/api/article/body?pathname=/en/get-started/start-your-journey/about-github-and-git"
Para acceder a un artículo con versiones (por ejemplo, para GitHub Enterprise Cloud), incluya la versión en la ruta de acceso:
curl "https://docs.github.com/api/article/body?pathname=/en/enterprise-cloud@latest/admin/overview/about-github-enterprise-cloud"
Obtención de metadatos de artículo
GET https://docs.github.com/api/article/meta devuelve metadatos sobre un artículo en formato JSON, incluidos el título, la introducción, el área del producto, el tipo de documento y las rutas de navegación.
curl "https://docs.github.com/api/article/meta?pathname=/en/get-started/start-your-journey/about-github-and-git"
Obtener contenido y metadatos juntos
GET https://docs.github.com/api/article devuelve los metadatos y el cuerpo del artículo en una única respuesta JSON, combinando los resultados del cuerpo y los meta endpoints.
curl "https://docs.github.com/api/article?pathname=/en/get-started/start-your-journey/about-github-and-git"
Punto de conexión de la lista de páginas
El extremo Pagelist devuelve una lista de todas las rutas de página disponibles para un idioma y una versión de la documentación determinados. Puede usarlo para obtener todos los artículos y, a continuación, recuperar cada artículo individual con el punto de conexión Article.
Enumerar todas las páginas
GET https://docs.github.com/api/pagelist/:lang/:version devuelve una nueva lista separada por líneas de todas las rutas de acceso de página para el idioma y la versión especificados.
curl "https://docs.github.com/api/pagelist/en/free-pro-team@latest"
Lista de idiomas
GET https://docs.github.com/api/pagelist/languages devuelve todos los códigos de idioma disponibles como JSON. Úselo para buscar valores válidos para el :lang parámetro anterior.
Lista de versiones
GET https://docs.github.com/api/pagelist/versions devuelve todas las versiones de documentación disponibles como JSON, incluidos GitHub Enterprise Server los números de versión. Úselo para buscar valores válidos para el :version parámetro anterior.
Punto de conexión de búsqueda
El endpoint de búsqueda permite buscar en todo el contenido de GitHub Docs. Devuelve los resultados ordenados por relevancia, con resaltados y metadatos para cada página coincidente.
Búsqueda de contenido de documentos
GET https://docs.github.com/api/search/v1 acepta los siguientes parámetros de consulta:
query(obligatorio): término de búsqueda.client_name(necesario para clientes externos comocurl): un nombre que identifica al cliente o la integración.version(opcional): La versión de la documentación en la que buscar. Tiene como valor predeterminadofree-pro-team. Los valores válidos incluyenfree-pro-team,enterprise-cloudy GitHub Enterprise Server, como los números de versión3.19.language(opcional): idioma que se va a buscar. Tiene como valor predeterminadoen.page(opcional): número de página para los resultados paginados. Tiene como valor predeterminado1.size(opcional): número de resultados por página, hasta un máximo de50. Tiene como valor predeterminado10.
curl "https://docs.github.com/api/search/v1?query=actions&client_name=docs-api-example&version=free-pro-team&language=en"
La respuesta incluye un meta objeto con información sobre el número total de coincidencias y una hits matriz que contiene las páginas coincidentes con títulos, direcciones URL, rutas de navegación y resaltados de contenido.
llms.txt para agentes de IA
GitHub Docs publica un llms.txt archivo en https://docs.github.com/llms.txt, siguiendo el llms.txt estándar. Este archivo proporciona información general estructurada del sitio de documentación diseñado para su consumo por parte de LLM y herramientas con tecnología de INTELIGENCIA ARTIFICIAL.
Si va a crear un agente o una herramienta que necesite acceder a GitHub Docs, llms.txt es el punto de partida recomendado para descubrir el contenido disponible y los puntos de conexión de la API.