Browse Source

add embedded search to docs

Noémi Ványi 8 years ago
parent
commit
013139b036
1 changed files with 16 additions and 0 deletions
  1. 16 0
      docs/admin/api.rst

+ 16 - 0
docs/admin/api.rst

@@ -76,3 +76,19 @@ Sample response
       ], 
       "safe_search": 0
     }
+
+Embed search bar
+----------------
+
+The search bar can be embedded into websites. Just paste the example into the HTML of the site.
+URL of the searx instance and values are customizable.
+
+.. code:: html
+    
+    <form method="post" action="https://searx.me/">
+        <!-- search query --> <input type="text" name="q" />
+        <!-- categories   --> <input type="hidden" name="categories" value="general,social media" />
+        <!-- language     --> <input type="hidden" name="lang" value="all" />
+        <!-- locale       --> <input type="hidden" name="locale" value="en" />
+        <!-- date filter  --> <input type="hidden" name="time_range" value="month" />
+    </form>