<feed xmlns='http://www.w3.org/2005/Atom'>
<title>searxng/.git/searx/help, branch master</title>
<subtitle>Unnamed repository; edit this file 'description' to name the repository.
</subtitle>
<link rel='alternate' type='text/html' href='https://git.slickd.xyz/searxng/.git/'/>
<entry>
<title>[mod] replace /help by /info pages and include pages in project docs</title>
<updated>2022-03-12T10:36:31+00:00</updated>
<author>
<name>Markus Heiser</name>
<email>markus.heiser@darmarit.de</email>
</author>
<published>2022-03-12T09:18:08+00:00</published>
<link rel='alternate' type='text/html' href='https://git.slickd.xyz/searxng/.git/commit/?id=b1912607ae9783d6ccf648bd7706a64eca5bedb9'/>
<id>b1912607ae9783d6ccf648bd7706a64eca5bedb9</id>
<content type='text'>
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 &lt;markus.heiser@darmarit.de&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
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 &lt;markus.heiser@darmarit.de&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>[help] move about.md to searx/help/en/</title>
<updated>2022-03-07T07:29:00+00:00</updated>
<author>
<name>Martin Fischer</name>
<email>martin@push-f.com</email>
</author>
<published>2022-02-05T09:29:33+00:00</published>
<link rel='alternate' type='text/html' href='https://git.slickd.xyz/searxng/.git/commit/?id=579334a7d806a8d8edc1f3a51399c05636354759'/>
<id>579334a7d806a8d8edc1f3a51399c05636354759</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>[help] remove link from about.md title</title>
<updated>2022-02-01T05:28:26+00:00</updated>
<author>
<name>Martin Fischer</name>
<email>martin@push-f.com</email>
</author>
<published>2022-01-31T10:31:07+00:00</published>
<link rel='alternate' type='text/html' href='https://git.slickd.xyz/searxng/.git/commit/?id=b93711b45da7e8d851be5a3d55ebf6fbe5423efd'/>
<id>b93711b45da7e8d851be5a3d55ebf6fbe5423efd</id>
<content type='text'>
Now that about.html extends page_with_header.html
it already has a link to the start page and removing
the link makes it easier to extract the page title
from the Markdown for the following commit.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Now that about.html extends page_with_header.html
it already has a link to the start page and removing
the link makes it easier to extract the page title
from the Markdown for the following commit.
</pre>
</div>
</content>
</entry>
<entry>
<title>[help] stop rendering documentation with Jinja2</title>
<updated>2022-01-23T07:01:55+00:00</updated>
<author>
<name>Martin Fischer</name>
<email>martin@push-f.com</email>
</author>
<published>2022-01-15T08:34:08+00:00</published>
<link rel='alternate' type='text/html' href='https://git.slickd.xyz/searxng/.git/commit/?id=105c5a6a9839c65a81b32cdf82278c5cc629ae4a'/>
<id>105c5a6a9839c65a81b32cdf82278c5cc629ae4a</id>
<content type='text'>
To facilitate translation of the user documentation we move
the templating logic outside of the user documentation.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
To facilitate translation of the user documentation we move
the templating logic outside of the user documentation.
</pre>
</div>
</content>
</entry>
<entry>
<title>[help] convert about.html to Markdown</title>
<updated>2022-01-23T07:01:55+00:00</updated>
<author>
<name>Martin Fischer</name>
<email>martin@push-f.com</email>
</author>
<published>2022-01-15T08:01:38+00:00</published>
<link rel='alternate' type='text/html' href='https://git.slickd.xyz/searxng/.git/commit/?id=284ac8bfd8a3d1f762c98a0195b98a45cdd089d3'/>
<id>284ac8bfd8a3d1f762c98a0195b98a45cdd089d3</id>
<content type='text'>
To facilitate translation the new user documentation shall be written in
Markdown (which is more human-friendly than HTML and reStructuredText).
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
To facilitate translation the new user documentation shall be written in
Markdown (which is more human-friendly than HTML and reStructuredText).
</pre>
</div>
</content>
</entry>
<entry>
<title>[help] render user documentation once on startup</title>
<updated>2022-01-23T07:01:55+00:00</updated>
<author>
<name>Martin Fischer</name>
<email>martin@push-f.com</email>
</author>
<published>2022-01-15T05:09:37+00:00</published>
<link rel='alternate' type='text/html' href='https://git.slickd.xyz/searxng/.git/commit/?id=05149db4c1e495eecaf74d267e91f61dee7ee40d'/>
<id>05149db4c1e495eecaf74d267e91f61dee7ee40d</id>
<content type='text'>
Currently we have two kinds of user documentation:

* the about page[1] which is written in HTML and part of the web
  application and can therefore link instance-specific pages
  (like e.g. the preferences) via Jinja variables

* the Sphinx documentation[2] which is written in reStructuredText
  and cannot link instance-specific pages since it doesn't know
  which instance the user is using

The plan is to integrate the user documentation currently in Sphinx
into the application, so that it can also link instance specific pages.
We also want to enable the user documentation to be translated.

This commit implements the first step in this endeavor (see #722).

[1]: searx/templates/__common__/about.html
[2]: docs/user/ (currently served at https://docs.searxng.org/user/)
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Currently we have two kinds of user documentation:

* the about page[1] which is written in HTML and part of the web
  application and can therefore link instance-specific pages
  (like e.g. the preferences) via Jinja variables

* the Sphinx documentation[2] which is written in reStructuredText
  and cannot link instance-specific pages since it doesn't know
  which instance the user is using

The plan is to integrate the user documentation currently in Sphinx
into the application, so that it can also link instance specific pages.
We also want to enable the user documentation to be translated.

This commit implements the first step in this endeavor (see #722).

[1]: searx/templates/__common__/about.html
[2]: docs/user/ (currently served at https://docs.searxng.org/user/)
</pre>
</div>
</content>
</entry>
</feed>
