mkdocs-izsam-search 0.1.3

MkDocs plugin to extend search functions

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 the search plugin. MkDocs enables it by default if there is no plugins entry set.

More information about plugins in the MkDocs documentation.

See Also

Change log

[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