You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Static export is gated behind **Enterprise plans**. To enable it for your organization, [contact sales](https://mintlify.com/contact/sales).
8
+
Static export requires an [Enterprise plan](https://mintlify.com/pricing?ref=static-export).
9
9
</Info>
10
10
11
-
Use the Static Export API to programmatically pre-render your documentation 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.
11
+
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.
12
12
13
-
## How it works
13
+
## How static export works
14
14
15
15
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.
16
16
17
17
<Steps>
18
-
<Steptitle="Kick off a static export job">
18
+
<Steptitle="Start a static export job">
19
19
Call [Start static export job](/api/static-export/start-job) with the domain you want to export. The API queues the job and returns a `jobId`.
20
20
</Step>
21
21
<Steptitle="Query the job status">
@@ -28,7 +28,7 @@ A static export runs as an asynchronous job. You start the job, poll for its sta
28
28
29
29
## Feature support by deployment
30
30
31
-
Which features are available depends on how you host your docs. Air-gapped deployments have no outbound network access, so anything that relies on Mintlify's cloud services is unavailable. **Configurable**means availability is determined by your environment's setup.
31
+
Which features are available depends on how you host your deployment. Air-gapped deployments have no outbound network access, so anything that relies on Mintlify's cloud services is unavailable. Features labeled **Configurable**have different availability depending on your environment's setup.
32
32
33
33
| Feature | Cloud | Client-hosted | Air-gapped |
34
34
| --- | :---: | :---: | :---: |
@@ -40,20 +40,16 @@ Which features are available depends on how you host your docs. Air-gapped deplo
40
40
41
41
## Endpoints
42
42
43
-
-[Start static export job](/api/static-export/start-job): Kick off a static export job for a deployment.
43
+
-[Start static export job](/api/static-export/start-job): Start a static export job for a deployment.
44
44
-[Get static export job status](/api/static-export/get-job-status): Poll the status and progress of a running job.
45
45
-[Generate export bundle](/api/static-export/generate-bundle): Package a completed job and return a single S3 link to the bundle.
46
46
47
47
## Authentication
48
48
49
-
Authenticate requests with your admin API key. Generate one on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin API keys begin with the `mint_` prefix and are server-side secrets--do not expose them in client-side code.
49
+
Authenticate requests with your admin API key. Generate an admin API key on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin API keys begin with the `mint_` prefix and are server-side secrets--do not expose them in client-side code.
50
50
51
51
## Deploy the bundle to your Enterprise Helm chart
52
52
53
-
<Note>
54
-
The Helm values and workflow below are a reference for an upcoming release. Exact value keys and behavior are subject to change. Reach out through your Enterprise channel for the current configuration.
55
-
</Note>
56
-
57
53
Self-hosted Mintlify is deployed with the Helm chart in the [`mintlify/enterprise`](https://github.com/mintlify/enterprise) repository. Once a static export job produces a bundle, you point the chart at the bundle and the deployment serves it from your own infrastructure.
58
54
59
55
<Steps>
@@ -81,11 +77,11 @@ Self-hosted Mintlify is deployed with the Helm chart in the [`mintlify/enterpris
81
77
</Step>
82
78
</Steps>
83
79
84
-
Because presigned links expire, regenerate the bundle and re-run the upgrade whenever you publish new content--or automate the whole loop with GitHub Actions below.
80
+
Because presigned links expire, regenerate the bundle and re-run the upgrade whenever you publish new contentor automate the loop with GitHub Actions.
85
81
86
82
## Automate with a GitHub Action
87
83
88
-
The following template workflow runs the full export loop on a schedule (or on demand): it starts a job, polls until the export completes, generates a bundle, and rolls the new `bundleUrl` into the Helm chart.
84
+
The following template workflow runs the full export loop on a schedule or on demand. It starts a job, polls until the export completes, generates a bundle, and rolls the new `bundleUrl` into the Helm chart.
0 commit comments