OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added tip about setting use_directory_urls: false for offline docs (#2470)

Browse Source
This commit is contained in:
johnthagen 2021-03-17 16:07:57 -04:00 committed by GitHub
parent f0e87564db
commit 9895a9a6e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/setup/setting-up-site-search.md
View File

@ -255,6 +255,12 @@ For setup instructions, refer to the [official documentation][18].
[17]: https://github.com/squidfunk/iframe-worker [17]: https://github.com/squidfunk/iframe-worker
[18]: https://github.com/wilhelmer/mkdocs-localsearch#installation-material-v5 [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 ## Customization
The search implementation of Material for MkDocs is probably its most The search implementation of Material for MkDocs is probably its most