summaryrefslogtreecommitdiff
path: root/searx/help
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2022-03-12 10:18:08 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2022-03-12 11:36:31 +0100
commitb1912607ae9783d6ccf648bd7706a64eca5bedb9 (patch)
treea27ada16192c85d3bd7fa25714a113e2d621433f /searx/help
parentbb71ebc3945b8e345bebe45a7d393afba6366ab9 (diff)
[mod] replace /help by /info pages and include pages in project docs
This patch implements a bolierplate to share content from info-pages of the SearXNG instance (URL /info) with the project documentation (path /docs/user). The info pages are using Markdown (CommonMark), to include them in the project documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain. If base_url is known (defined in settings.yml) links to the instance are also inserted into the project documentation:: searxng_extra/docs_prebuild [1] https://www.sphinx-doc.org/en/master/usage/markdown.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'searx/help')
-rw-r--r--searx/help/en/about.md71
1 files changed, 0 insertions, 71 deletions
diff --git a/searx/help/en/about.md b/searx/help/en/about.md
deleted file mode 100644
index dd7cd4515..000000000
--- a/searx/help/en/about.md
+++ /dev/null
@@ -1,71 +0,0 @@
-# About SearXNG
-
-SearXNG is a fork from the well-known [searx] [metasearch engine], aggregating
-the results of other [search engines][url_for:preferences] while not storing
-information about its users.
-
-More about SearXNG ...
-
-* [SearXNG sources][brand.git_url]
-* [weblate]
-
----
-
-## Why use it?
-
-* SearXNG may not offer you as personalised results as Google,
- but it doesn't generate a profile about you.
-
-* SearXNG doesn't care about what you search for, never shares anything
- with a third party, and it can't be used to compromise you.
-
-* SearXNG is free software, the code is 100% open and you can help
- to make it better. See more on [SearXNG sources][brand.git_url].
-
-If you do care about privacy, want to be a conscious user, or otherwise
-believe in digital freedom, make SearXNG your default search engine or run
-it on your own server
-
-## Technical details - How does it work?
-
-SearXNG is a [metasearch engine], inspired by the [seeks project]. It provides
-basic privacy by mixing your queries with searches on other platforms without
-storing search data. Queries are made using a POST request on every browser
-(except Chromium-based browsers*). Therefore they show up in neither our logs,
-nor your url history. In the case of Chromium-based browser users there is an
-exception: searx uses the search bar to perform GET requests. SearXNG can be
-added to your browser's search bar; moreover, it can be set as the default
-search engine.
-
-<span id='add to browser'></span>
-## How to set as the default search engine?
-
-SearXNG supports [OpenSearch]. For more information on changing your default
-search engine, see your browser's documentation:
-
-* [Firefox](https://support.mozilla.org/en-US/kb/add-or-remove-search-engine-firefox)
-* [Microsoft Edge](https://support.microsoft.com/en-us/help/4028574/microsoft-edge-change-the-default-search-engine)
-* Chromium-based browsers [only add websites that the user navigates to without a path.](https://www.chromium.org/tab-to-search)
-
-## Where to find anonymous usage statistics of this instance ?
-
-[Stats page][url_for:stats] contains some useful data about the engines used.
-
-## How can I make it my own?
-
-SearXNG appreciates your concern regarding logs, so take the code from
-the [SearXNG project][brand.git_url] and run it yourself!
-
-Add your instance to this [list of public instances][brand.public_instances] to
-help other people reclaim their privacy and make the Internet freer! The more
-decentralized the Internet is, the more freedom we have!
-
-## Where are the docs & code of this instance?
-
-See the [SearXNG docs][brand.docs_url] and [SearXNG sources][brand.git_url]
-
-[searx]: https://github.com/searx/searx
-[metasearch engine]: https://en.wikipedia.org/wiki/Metasearch_engine
-[weblate]: https://weblate.bubu1.eu/projects/searxng/
-[seeks project]: https://beniz.github.io/seeks/
-[OpenSearch]: https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md