Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions api/static-export/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@

Use the static export API to programmatically pre-render your site into a self-contained set of static files and download the result as a single bundle. The exported bundle is pure HTML, CSS, and JavaScript with no runtime dependencies, so you can host it on any static file storage or CDN.

## Page URLs in static bundles

Static export bundles use explicit `.html` page URLs. For example, `/guides/getting-started` becomes `/guides/getting-started.html`, and the home page becomes `/index.html`.

Check warning on line 15 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L15

Use 'HTML' instead of 'html'.

Check warning on line 15 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L15

Use 'HTML' instead of 'html'.

Check warning on line 15 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L15

Use 'HTML' instead of 'html'.

This format matches the files in the bundle and supports S3 or plain static hosting without extensionless URL rewrites. Preserve `.html` filenames when you upload the bundle. The Static Export API enables this format automatically, so you do not need to change your documentation configuration.

Check warning on line 17 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L17

Did you really mean 'extensionless'?

CloudFront deployments preserve client-side navigation and prefetching. Plain file hosts support full-page navigation through generated `.html` links. Cloud-hosted production sites remain unchanged.

Built-in internal navigation, including version and language switchers, search results, cards, assistant citations, and API playground links, also uses `.html` destinations. Query strings remain intact, so API playground links continue to work.

<Note>
Canonical and sitemap URLs remain extensionless. Custom client-side navigation URLs can also remain extensionless. CloudFront-backed deployments resolve them, while file-only hosts may need rewrites.

Check warning on line 24 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L24

Did you really mean 'extensionless'?

Check warning on line 24 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L24

Did you really mean 'extensionless'?
</Note>

## How static export works

A static export runs as an asynchronous job. You start the job, poll for its status, and then generate a downloadable bundle once the job completes.
Expand Down
19 changes: 19 additions & 0 deletions es/api/static-export/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,25 @@ keywords: ["static export", "static site", "bundle", "self-host", "enterprise"]

Usa la API de exportación estática para prerenderizar tu sitio de forma programática en un conjunto autocontenido de archivos estáticos y descargar el resultado como un único paquete. El paquete exportado es HTML, CSS y JavaScript puros, sin dependencias en tiempo de ejecución, por lo que puedes alojarlo en cualquier almacenamiento de archivos estáticos o CDN.

<div id="page-urls-in-static-bundles">
## URLs en paquetes estáticos
</div>

Los paquetes de exportación estática usan URLs de página explícitas con la extensión `.html`.
La exportación convierte `/guides/getting-started` en `/guides/getting-started.html`.
La exportación convierte la página de inicio en `/index.html`.
Este formato coincide con los archivos del paquete y permite alojarlos en S3 o en un hosting estático sencillo, sin reescrituras para URLs sin extensión.
Conserva los nombres de archivo `.html` al subirlos. La API de exportación estática habilita este formato automáticamente, por lo que no necesitas cambiar la configuración de tu documentación.
Los despliegues con CloudFront conservan la navegación del lado del cliente y la precarga.
Los servidores que solo sirven archivos permiten la navegación de página completa mediante los enlaces `.html` generados.
Los sitios de producción alojados en la nube siguen sin cambios.

La navegación interna integrada también utiliza destinos `.html`. Esto incluye los selectores de versión e idioma, los resultados de búsqueda, las tarjetas, las citas del asistente y los enlaces del playground de API. Las cadenas de consulta se conservan, por lo que los enlaces del playground de API siguen funcionando.

<Note>
Las URL canónicas y las del sitemap siguen sin extensión. Las URL personalizadas de navegación del lado del cliente también pueden seguir sin extensión. Los despliegues con CloudFront las resuelven, pero los servidores que solo sirven archivos quizá necesiten reescrituras.
</Note>

<div id="how-static-export-works">
## Cómo funciona la exportación estática
</div>
Expand Down
16 changes: 16 additions & 0 deletions fr/api/static-export/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,22 @@ keywords: ["static export", "static site", "bundle", "self-host", "enterprise"]

Utilisez l'API d'exportation statique pour pré-rendre votre site par programmation en un ensemble autonome de fichiers statiques et télécharger le résultat sous forme d'un unique bundle. Le bundle exporté est composé de HTML, CSS et JavaScript purs, sans dépendances d'exécution, afin que vous puissiez l'héberger sur n'importe quel stockage de fichiers statiques ou CDN.

<div id="page-urls-in-static-bundles">
## URL des pages exportées
</div>

Les bundles d’exportation statique utilisent des URL de pages explicites avec l’extension `.html`. Ainsi, `/guides/getting-started` devient `/guides/getting-started.html`, et la page d’accueil devient `/index.html`.

Cette structure correspond aux fichiers du bundle. Elle permet un hébergement S3 ou statique simple, sans nécessiter la réécriture d’URL sans extension. Conservez les noms de fichiers `.html` lors du téléversement. L’API d’exportation statique active automatiquement ce format, vous n’avez donc pas besoin de modifier la configuration de votre documentation.

Les déploiements avec CloudFront préservent la navigation côté client et le préchargement des pages. Les hébergeurs de fichiers simples prennent en charge la navigation par pages complètes grâce aux liens `.html` générés. Les sites de production hébergés normalement dans le cloud restent inchangés.

La navigation interne intégrée utilise également des destinations en `.html`. Cela concerne notamment les sélecteurs de version et de langue, les résultats de recherche, les cartes, les citations de l’assistant et les liens du playground d’API. Les chaînes de requête sont conservées. Les liens du playground d’API continuent donc de fonctionner.

<Note>
Les URL canoniques et celles du sitemap restent sans extension. Vos URL personnalisées de navigation côté client peuvent également rester sans extension. Les déploiements reposant sur CloudFront les résolvent, mais les hébergeurs qui servent uniquement des fichiers peuvent nécessiter des réécritures.
</Note>

<div id="how-static-export-works">
## Fonctionnement de l'exportation statique
</div>
Expand Down
16 changes: 15 additions & 1 deletion zh/api/static-export/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "静态导出"
description: "通过 Mintlify REST API 生成自包含的文档静态导出,并以单个包的形式下载。"
description: "通过 Mintlify REST API 生成自包含的文档静态导出,并以单个包的形式下载。了解如何预渲染文档、部署静态文件,并在 S3、CDN 或其他静态托管服务上托管。"
keywords: ["static export", "static site", "bundle", "self-host", "enterprise"]
---

Expand All @@ -10,6 +10,20 @@ keywords: ["static export", "static site", "bundle", "self-host", "enterprise"]

使用静态导出 API 以编程方式将站点预渲染为一组自包含的静态文件,并将结果作为单个包下载。导出的包为纯 HTML、CSS 和 JavaScript,没有运行时依赖,因此你可以将其托管在任何静态文件存储或 CDN 上。

<div id="page-urls-in-static-bundles">
## 静态导出包中的页面 URL
</div>

静态导出包使用明确的 `.html` 页面 URL。`/guides/getting-started` 会变为 `/guides/getting-started.html`,首页则为 `/index.html`。这样 URL 与包中的文件相对应,可以直接部署到 S3 或普通静态托管,无需将无扩展名 URL 重写为文件路径。上传时请保留 `.html` 文件名。静态导出 API 会自动启用此格式,因此你无需修改文档配置。

部署到 CloudFront 时,客户端导航和预取仍可正常工作。仅支持文件访问的托管服务则通过生成的 `.html` 链接支持整页导航。普通云托管生产站点不受影响。

内置控件在进行内部导航时也会使用 `.html` 目标地址,包括版本和语言切换器、搜索结果、卡片、助手引用及 API playground 链接。查询字符串会保留,因此 API playground 链接仍可正常工作。

<Note>
canonical 和 sitemap 中的 URL 仍保持无扩展名;自定义的客户端导航 URL 也可以继续使用无扩展名。CloudFront 部署会解析这些 URL,但仅提供文件的托管服务可能需要配置重写。
</Note>

<div id="how-static-export-works">
## 静态导出的工作原理
</div>
Expand Down