diff --git a/deploy/export.mdx b/deploy/export.mdx index dffd7711d..de99537aa 100644 --- a/deploy/export.mdx +++ b/deploy/export.mdx @@ -21,11 +21,16 @@ The CLI bundles the icons, fonts, and LaTeX styles your site uses into the archi ## Limitations -- Offline exports do not support search. To add offline search, index the exported HTML with a static search tool. - Offline exports do not support the Mintlify assistant. - Offline exports do not include analytics or other [integrations](/organize/settings-integrations) configured in your `docs.json`. - Images and other files that your pages reference by external URL are not bundled. Store them in your project to include them in the archive. +### Offline search + +The search bar works in exported docs without a network connection. When you run `mint export`, the CLI builds a search index from the exported pages and saves it in the archive. The browser searches that index locally. + +Offline search follows the same rules as search on your live site. It skips pages that are [hidden from search](/organize/hidden-pages), such as pages with `noindex: true` or `searchable: false` in their frontmatter. Results only include pages in the reader's current language and version. + ### Bundled assets When you run `mint export`, the CLI downloads assets that your site loads from external hosts and saves them in the archive. This includes: @@ -97,6 +102,7 @@ The exported archive contains your pre-rendered pages, their bundled assets, and | `index.txt` files | Page data for client-side navigation, saved next to each page's HTML | | `_next/static/` | Bundled CSS, JavaScript, and other static assets | | `_mintlify/export-assets/` | Icons, fonts, and other assets downloaded from external hosts | +| `_mintlify/search-index.json` | Search index for [offline search](#offline-search) | | `llms.txt` | Index of the exported pages for AI tools | | `README.md` | Instructions for viewing the export and hosting it on your own server | | `serve.js` | Zero-dependency Node.js HTTP server that serves the site |