summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2022-07-25 17:35:40 +0200
committerGitHub <noreply@github.com>2022-07-25 17:35:40 +0200
commita3cfa206967937ccb89b3d534545189c5d4febd2 (patch)
treecc3cd86856d82325d35115473ef3947b471d3742
parentb14ec7286d3d6517d5266870d546aaa1c7e41656 (diff)
parent5795c1971f5931cd7ff0361b7c47f9425a76a112 (diff)
Merge pull request #1553 from return42/fix-1548
[fix] update documentation of Search-API (/dev)
-rw-r--r--docs/dev/search_api.rst30
1 files changed, 20 insertions, 10 deletions
diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst
index 527259269..3a56b9991 100644
--- a/docs/dev/search_api.rst
+++ b/docs/dev/search_api.rst
@@ -91,22 +91,32 @@ Parameters
``enabled_plugins`` : optional
List of enabled plugins.
- :default: ``HTTPS_rewrite``, ``Self_Informations``,
- ``Search_on_category_select``, ``Tracker_URL_remover``
+ :default:
+ ``Hash_plugin``, ``Search_on_category_select``,
+ ``Self_Informations``, ``Tracker_URL_remover``,
+ ``Ahmia_blacklist``
- :values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``,
- ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``,
- ``Search_on_category_select``, ``Hostname_replace``, ``Tor_check_plugin``
+ :values:
+ .. enabled by default
+
+ ``Hash_plugin``, ``Search_on_category_select``,
+ ``Self_Informations``, ``Tracker_URL_remover``,
+ ``Ahmia_blacklist``,
+
+ .. disabled by default
+
+ ``Hostname_replace``, ``Open_Access_DOI_rewrite``,
+ ``Vim-like_hotkeys``, ``Tor_check_plugin``
``disabled_plugins``: optional
List of disabled plugins.
- :default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``,
- ``Hostname_replace``, ``Tor_check_plugin``
+ :default:
+ ``Hostname_replace``, ``Open_Access_DOI_rewrite``,
+ ``Vim-like_hotkeys``, ``Tor_check_plugin``
- :values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``,
- ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``,
- ``Search_on_category_select``, ``Hostname_replace``, ``Tor_check_plugin``
+ :values:
+ see values from ``enabled_plugins``
``enabled_engines`` : optional : *all* :origin:`engines <searx/engines>`
List of enabled engines.