From 9895a9a6e0020f7ed6a1473bc57425324e40d88d Mon Sep 17 00:00:00 2001 From: johnthagen Date: Wed, 17 Mar 2021 16:07:57 -0400 Subject: [PATCH] Added tip about setting use_directory_urls: false for offline docs (#2470) --- docs/setup/setting-up-site-search.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/setup/setting-up-site-search.md b/docs/setup/setting-up-site-search.md index 0bef81bb6..5e91ff185 100644 --- a/docs/setup/setting-up-site-search.md +++ b/docs/setup/setting-up-site-search.md @@ -255,6 +255,12 @@ For setup instructions, refer to the [official documentation][18]. [17]: https://github.com/squidfunk/iframe-worker [18]: https://github.com/wilhelmer/mkdocs-localsearch#installation-material-v5 +!!! tip + + When distributing documentation as HTML files to be opened from the file + system, you will also want to set `use_directory_urls: false` in + `mkdocs.yml` to make page links function correctly. + ## Customization The search implementation of Material for MkDocs is probably its most