From b1912607ae9783d6ccf648bd7706a64eca5bedb9 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
Date: Sat, 12 Mar 2022 10:18:08 +0100
Subject: [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>
---
 searx/templates/simple/info.html | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 searx/templates/simple/info.html

(limited to 'searx/templates/simple/info.html')

diff --git a/searx/templates/simple/info.html b/searx/templates/simple/info.html
new file mode 100644
index 000000000..ef6b343ad
--- /dev/null
+++ b/searx/templates/simple/info.html
@@ -0,0 +1,14 @@
+{% extends 'simple/page_with_header.html' %}
+{% block title %}{{ active_page.title }} - {% endblock %}
+{% block content %}
+<ul class="tabs">
+{% for pagename, page in all_pages('en') %}
+  <li>
+    <a href="{{pagename}}" {% if pagename == active_pagename %}class="active"{% endif %}>{{page.title}}</a>
+  </li>
+{% endfor %}
+</ul>
+<div class="info-page {{pagename}}">
+  {{- active_page.html | safe -}}
+</div>
+{% endblock %}
-- 
cgit v1.2.3