Skip to content

Commit 9895a9a

Browse files
authored
Added tip about setting use_directory_urls: false for offline docs (#2470)
1 parent f0e8756 commit 9895a9a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/setup/setting-up-site-search.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,12 @@ For setup instructions, refer to the [official documentation][18].
255255
[17]: https://github.com/squidfunk/iframe-worker
256256
[18]: https://github.com/wilhelmer/mkdocs-localsearch#installation-material-v5
257257

258+
!!! tip
259+
260+
When distributing documentation as HTML files to be opened from the file
261+
system, you will also want to set `use_directory_urls: false` in
262+
`mkdocs.yml` to make page links function correctly.
263+
258264
## Customization
259265

260266
The search implementation of Material for MkDocs is probably its most

0 commit comments

Comments
 (0)