Building for Offline Usage
Building For Offline Usage
If you want to ship your documentation together with your product, MkDocs has you covered – with support from themes, MkDocs supports building offline-capable documentation. Notably, Material for MkDocs offers offline support for many of its features.
Back to: #Advanced-Configuration
Configuration⚓︎
Built-in offline Plugin⚓︎
Built-in offline Plugin
The built-in offline plugin makes sure that the site search works when you distribute the contents of your site directory as a download. Simply add the following lines to mkdocs.yml:
For a list of all settings, please consult the plugin documentation.
Automatically bundle all external assets
The built-in privacy plugin makes it easy to use external assets while building documentation for offline usage, as it will automatically download all external assets to distribute them with your documentation.
Limitations⚓︎
Limitations
Material for MkDocs offers many interactive features, some of which will not work from the file system due to the restrictions of modern browsers: all features that use the fetch API will error.
Thus, when building for offline usage, make sure to disable the following configuration settings: instant loading, site analytics, git repository, versioning and comment systems.