mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
94 lines
3.5 KiB
Markdown
94 lines
3.5 KiB
Markdown
|
---
|
|||
|
|
template: overrides/main.html
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# Building for offline usage
|
|||
|
|
|
|||
|
|
If you want to ship your documentation together with your product, MkDocs has
|
|||
|
|
you covered – with support from themes, [MkDocs] allows for building
|
|||
|
|
offline-capable documentation. Luckily, Material for MkDocs offers offline
|
|||
|
|
support for many of its features.
|
|||
|
|
|
|||
|
|
[MkDocs]: https://www.mkdocs.org
|
|||
|
|
|
|||
|
|
## Configuration
|
|||
|
|
|
|||
|
|
### Built-in offline plugin
|
|||
|
|
|
|||
|
|
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
|
|||
|
|
[:octicons-tag-24: insiders-4.10.0][Insiders] ·
|
|||
|
|
:octicons-cpu-24: Plugin ·
|
|||
|
|
:octicons-beaker-24: Experimental
|
|||
|
|
|
|||
|
|
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`:
|
|||
|
|
|
|||
|
|
``` yaml
|
|||
|
|
plugins:
|
|||
|
|
- offline # (1)!
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
1. Note that the offline plugin should be located at the end of the list of
|
|||
|
|
`plugins`, as it will post-process the search index. If you want to use
|
|||
|
|
other plugins that alter the search index together with this plugin, add
|
|||
|
|
them before the built-in offline plugin.[^1]
|
|||
|
|
|
|||
|
|
[^1]:
|
|||
|
|
Offline search was previously implemented through the third-party
|
|||
|
|
[localsearch] plugin, which is still possible if you don't want to use
|
|||
|
|
[Insiders]. Note, however, that setup might be challenging if you're not
|
|||
|
|
experienced with MkDocs.
|
|||
|
|
|
|||
|
|
The plugin will automatically disable [`use_directory_urls`][use_directory_urls]
|
|||
|
|
via `mkdocs.yml`, ensuring that the user can open your documentation directly
|
|||
|
|
from the local file system.
|
|||
|
|
|
|||
|
|
The following configuration options are available:
|
|||
|
|
|
|||
|
|
`enabled`{ #enabled }
|
|||
|
|
|
|||
|
|
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
|||
|
|
the plugin is enabled when building your project. If you want to switch
|
|||
|
|
the plugin off, e.g. for local builds, use an [environment variable]:
|
|||
|
|
|
|||
|
|
``` yaml
|
|||
|
|
plugins:
|
|||
|
|
- privacy:
|
|||
|
|
enabled: !ENV [OFFLINE, false]
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
Now, after invoking `mkdocs build`, you can open `site/index.html` directly
|
|||
|
|
in your browser and the [site search] will work as if the documentation was
|
|||
|
|
hosted on a regular server.
|
|||
|
|
|
|||
|
|
!!! tip "Automatically bundle all external assets"
|
|||
|
|
|
|||
|
|
The brand-new [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.
|
|||
|
|
|
|||
|
|
[Insiders]: ../insiders/index.md
|
|||
|
|
[site search]: setting-up-site-search.md
|
|||
|
|
[site directory]: https://www.mkdocs.org/user-guide/configuration/#site_dir
|
|||
|
|
[localsearch]: https://github.com/wilhelmer/mkdocs-localsearch/
|
|||
|
|
[use_directory_urls]: https://www.mkdocs.org/user-guide/configuration/#use_directory_urls
|
|||
|
|
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
|
|||
|
|
[built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin
|
|||
|
|
|
|||
|
|
#### 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].
|
|||
|
|
|
|||
|
|
[Instant loading]: setting-up-navigation.md#instant-loading
|
|||
|
|
[Site analytics]: setting-up-site-analytics.md
|
|||
|
|
[Versioning]: setting-up-versioning.md
|
|||
|
|
[Git repository]: adding-a-git-repository.md
|
|||
|
|
[Comment systems]: adding-a-comment-system.md
|