Markus Heiser
d471ec86dd
Makefile: add target node.env - download & install npm dependencies
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
757ebb5d9f
[fix] brands: add variables from build env to grunt process
...
We have some variables in the build environment which are also needed in the
grunt process when building themes. Theses variables are relavant if one
creates a fork with its own branding. We treat these variables under the term
'brands'.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
04ad648105
makefile.python: remove python2 support
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
4d67164918
Merge branch 'master' of https://github.com/asciimoo/searx into filtron
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
a9d184473f
docs: fix dead Searx-instance links to https://searx.space
...
Related to #1853 / BTW update year of copyright note
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
a99c65dd01
docs: misc marginal fixes
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
eedd63ccd5
docs: revision of the installation instructions
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
9278f0fb45
docs: add some documentation about the tooling box ./utils/*
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
bdf392093a
build requirements: add a shell script static analysis tool
...
ShellCheck: https://github.com/koalaman/shellcheck
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
f602cb8e4d
docs(admin): moved settings description from wiki to docs
...
Move wiki entry https://github.com/asciimoo/searx/wiki/settings.yml
into admin section of the docs (#1785 ).
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
f9be534b2a
docs(dev): fix minor markup typos
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
d6f2802e4b
docs(dev): add more markups to reST primer
...
- Literal blocks
- Unicode substitution
- Horizontal list
- Math equations
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
92afe68d65
doc(dev): reST/sphinx add tabbed views extension (sphinx_tabs.tabs)
...
See issue #1785 :
idea: in the doc, provide installation instructions with one tab per
distrubution
preview (don't bookmark):
https://return42.github.io/searx/dev/reST.html#tabbed-views
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
62505f8982
docs(dev): add refs to to gitmoji and Semantic PR in contrib section
...
preview (don't bookmark):
https://return42.github.io/searx/dev/contribution_guide.html#code
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
4ca8b69c81
doc(dev): add remarks about creating good commits (messages)
...
preview (don't bookmark):
https://return42.github.io/searx/dev/contribution_guide.html#code
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
c8645d6e37
doc: reST-primer -- imrpove desription of definition lists
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
90174e215c
doc: add plugin section to admin section (template)
...
- Plugins configured at built time (defaults)
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
31db843c9c
doc: CSS - fix alignment of code block in figure blocks
...
BTW: minor profread of reST.rst
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
aa3b0265e7
doc: add 'Architecture' article to admin section
...
Herein we add some hints and suggestions about typical architectures of
searx infrastructures. We start with a contribution from @dalf
- https://github.com/asciimoo/searx/pull/1776#issuecomment-567917320
thanks @dalf !!
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
d1154202bc
doc: add reST templating // incl. generic engine tabe
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
c2b9aa0c2f
docs: reST-primer describe table markup (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
b201f84595
docs: reST-primer continued proofreading (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
ae7cb5937e
docs: reST-primer first proofreading (WIP)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
b82f61f704
doc: reST primer -- describe admonitions & customize their CSS
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
e1566e68aa
doc: add content to reST primer (WIP) // linuxdoc
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
bee19a76f7
doc: add reST primer (inital / WIP)
...
preview: https://return42.github.io/searx/dev/reST.html
includes:
- :class: rst-example // admonitions with (rendered) reST markup example
- extlinks to docutils
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
2b4526916d
edoc: -- makefile.rst fix typo and add extlinks['man']
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
f09459b98a
doc: describe Makefile targets
...
With the aim to simplify development cycles, started with PR #1756 a Makefile
based boilerplate was added. This patch adds the missing developer
documentation.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
fcd7f4cd12
doc: add note about docs-clean target
...
BTW: fix some typos
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
97b86fd184
doc: document the new reST & gh-pages workflow
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
04eeeb53a1
doc: moved reST sources in the right folder (much clearer)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
e9fff4fde6
doc: proofread of the all reST sources (no content change)
...
Normalize reST sources with best practice and KISS in mind.
to name a few points:
- simplify reST tables
- make use of ``literal`` markup for monospace rendering
- fix code-blocks for better rendering in HTML
- normalize section header markup
- limit all lines to a maximum of 79 characters
- add option -H to the sudo command used in code blocks
- drop useless indentation of lists
- ...
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
5b14772b20
doc: installation.rst improve reST markup
...
- normalize section header markup
- limit all lines to a maximum of 79 characters
- add option -H to the sudo command used in code blocks
- place *WARNING* lines into a '.. warning::' admonition block
- make use of ``literal`` markup for monospace rendering
- drop useless indentation of lists
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Markus Heiser
af2cae6d1d
doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx
...
- add sphinx extensions
- patch documentation to make use of
These modules help to simplify the reST markup of external references. BTW it
helps to write more readable reST and form custom brands.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
5 years ago
Noémi Ványi
021e1da4c9
add post about introducing offline engines
5 years ago
pofilo
c1ccb25d56
Merge pull request #1389 from bourrel/patch-1
...
Update quickstart.rst
6 years ago
tmikaeld
77494166d2
Formatting...
6 years ago
tmikaeld
10ebe8cec9
Added missing symlink instruction
6 years ago
Léo Bourrel
94af140318
Update quickstart.rst
...
Rename `build_grunt` to `grunt_build` as in manage.sh
6 years ago
Noémi Ványi
2134c7c693
change python-pybabel to python-babel in package requirements
...
Closes #1147
7 years ago
Noémi Ványi
07ef4a3e4a
update search api with params and description on syntax
7 years ago
Noémi Ványi
74d8ed284d
add format param to search api
7 years ago
Adam Tauber
b92631bf8c
various mods: uwsgi setup and version update ++ py3 img src fix ++ new sphinx version - closes #939
7 years ago
Noémi Ványi
1bd51c6de2
rewrite Translation page
8 years ago
Noémi Ványi
6ecd8e3bd7
installation: nginx mod to sites-enabled
8 years ago
Noémi Ványi
50f25193c1
engine overview fix torrent table
8 years ago
Noémi Ványi
c2cf46092e
docs: fix typos based on #653
8 years ago
Noemi Vanyi
daf736f1dd
add possible values of time_range param
8 years ago
Noémi Ványi
6d99db7af3
add new search parameter time_range
8 years ago
Noemi Vanyi
9e135f9fab
simplify index page
8 years ago
Noemi Vanyi
2ad8715b32
better API docs && more features in list
8 years ago
Noemi Vanyi
b40d7a2b36
add reverse proxy configuration
9 years ago
Noemi Vanyi
2430baa1fd
update install docs on reverse proxy
9 years ago
Noemi Vanyi
9c56154cfe
add dev tips to quickstart
9 years ago
Noemi Vanyi
016ab5c1e8
add development quickstart
9 years ago
Thomas Pointhuber
cf9bd14a7d
[fix] little typo
9 years ago
Thomas Pointhuber
fb62d01194
[enh] improve translation documentation
9 years ago
Noemi Vanyi
08d26609a5
update & fix install guide after install refactor
9 years ago
Noemi Vanyi
3b06814192
[doc] rewrite contribution guide
9 years ago
Noemi Vanyi
240802003e
[doc] fix small mistakes in engine overview
9 years ago
Noemi Vanyi
ae69a58089
[doc] grammar & format fixes in engine overview
9 years ago
Adam Tauber
11d6d80d88
[doc] engines overview added
9 years ago
Adam Tauber
1d6597b407
[enh] initial structure
9 years ago