MkDocs plugin to extend search functions
Project description
mkdocs-search-izsam
This is a MkDocs plugin that extends native search plugin in order to allow searches work locally. It will write a .js (file instead of a .json) that can be load in a theme using:
<script src="{{ 'search/search_index.js'|url }}"></script>
Important!
The plugin is intended to work only with custom themes. The theme should be configured to use the search_index_only
option as true
.
theme:
name: null
custom_dir: your_custom_theme
include_search_page: true
search_index_only: true
For additional information please refer to https://www.mkdocs.org/dev-guide/themes/#search-and-themes
Setup
Install the plugin using pip:
pip install mkdocs-izsam-search
Activate the plugin in mkdocs.yml
:
plugins:
- izsam-search
Note: If you have no
plugins
entry in your config file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set.
More information about plugins in the MkDocs documentation.
See Also
Change log
[0.1.3] - 2021-11-10
Setup
- entry_points declaration in setup()
[0.1.3] - 2021-11-10
Debug on MANIFEST.in
- Modified
MANIFEST.in
there was an error causing import data issues
[0.1.2] - 2021-11-10
Edited
README.md
[0.0.1] - 2021-11-10
Added
HISTORY.md
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-izsam-search-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5662b2bf4188ba9278e19ff6bd22bde4a686fb24479c4828907edd1761823eb4 |
|
MD5 | ed4353fed19d83636f35c04bf397c965 |
|
BLAKE2b-256 | 15e420882b8568f72952343f680882015cf1ff4499097749ebc4d5debb619dfb |
Hashes for mkdocs_izsam_search-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0f7649595f808779e71e0a779069fa480268db787fe75083b0e36214c4273be |
|
MD5 | 53f914c63b1fb8c7109bc5bdbf6194c8 |
|
BLAKE2b-256 | dc8f1020fae1c7e3c8c9040e7ed2b1518b358fb7ab34524777cdde8b48f31543 |