Skip to content

Commit cc1a770

Browse files
committed
💅
1 parent 393d957 commit cc1a770

1 file changed

Lines changed: 9 additions & 13 deletions

File tree

‎api/static-export/overview.mdx‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ keywords: ["static export", "static site", "bundle", "self-host", "enterprise"]
55
---
66

77
<Info>
8-
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).
99
</Info>
1010

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.
1212

13-
## How it works
13+
## How static export works
1414

1515
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.
1616

1717
<Steps>
18-
<Step title="Kick off a static export job">
18+
<Step title="Start a static export job">
1919
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`.
2020
</Step>
2121
<Step title="Query the job status">
@@ -28,7 +28,7 @@ A static export runs as an asynchronous job. You start the job, poll for its sta
2828

2929
## Feature support by deployment
3030

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.
3232

3333
| Feature | Cloud | Client-hosted | Air-gapped |
3434
| --- | :---: | :---: | :---: |
@@ -40,20 +40,16 @@ Which features are available depends on how you host your docs. Air-gapped deplo
4040

4141
## Endpoints
4242

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.
4444
- [Get static export job status](/api/static-export/get-job-status): Poll the status and progress of a running job.
4545
- [Generate export bundle](/api/static-export/generate-bundle): Package a completed job and return a single S3 link to the bundle.
4646

4747
## Authentication
4848

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.
5050

5151
## Deploy the bundle to your Enterprise Helm chart
5252

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-
5753
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.
5854

5955
<Steps>
@@ -81,11 +77,11 @@ Self-hosted Mintlify is deployed with the Helm chart in the [`mintlify/enterpris
8177
</Step>
8278
</Steps>
8379

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 content or automate the loop with GitHub Actions.
8581

8682
## Automate with a GitHub Action
8783

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.
8985

9086
```yaml .github/workflows/static-export.yml
9187
name: Publish static export

0 commit comments

Comments
 (0)