aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2018-10-03 19:29:20 +0000
committerGitHub <noreply@github.com>2018-10-03 19:29:20 +0000
commit10a7b5cee96a742fbe86edbea977f3c55c92e9aa (patch)
tree1f9541e502bd49774453bc27ef4f43b959c234d4 /doc
parent4adeffd7f427580bba6f7656360850d4460c1f1d (diff)
parent6c44d604a1ee0360a2eaf24b9cac18ca95edcb5f (diff)
downloadShaarli-10a7b5cee96a742fbe86edbea977f3c55c92e9aa.tar.gz
Shaarli-10a7b5cee96a742fbe86edbea977f3c55c92e9aa.tar.zst
Shaarli-10a7b5cee96a742fbe86edbea977f3c55c92e9aa.zip
Merge pull request #1220 from nodiscc/doc-robots-noindex-nofollow
add "noindex, nofollow" HTML robots meta-tag to documentation pages
Diffstat (limited to 'doc')
-rw-r--r--doc/custom_theme/main.html25
-rw-r--r--doc/md/Server-configuration.md7
2 files changed, 32 insertions, 0 deletions
diff --git a/doc/custom_theme/main.html b/doc/custom_theme/main.html
new file mode 100644
index 00000000..69b398f6
--- /dev/null
+++ b/doc/custom_theme/main.html
@@ -0,0 +1,25 @@
1{% extends "base.html" %}
2
3{#
4The entry point for the ReadTheDocs Theme.
5
6Any theme customisations should override this file to redefine blocks defined in
7the various templates. The custom theme should only need to define a main.html
8which `{% extends "base.html" %}` and defines various blocks which will replace
9the blocks defined in base.html and its included child templates.
10#}
11
12{%- block site_meta %}
13<meta charset="utf-8">
14<meta http-equiv="X-UA-Compatible" content="IE=edge">
15<meta name="viewport" content="width=device-width, initial-scale=1.0">
16
17{%- if 'media.readthedocs.org' not in config.extra_css[0] %}
18<meta name="robots" content="noindex, nofollow">
19{%- endif %}
20
21{% if page and page.is_homepage %}<meta name="description" content="{{ config.site_description }}">{% endif %}
22{% if config.site_author %}<meta name="author" content="{{ config.site_author }}">{% endif %}
23{% if config.site_favicon %}<link rel="shortcut icon" href="{{ config.site_favicon|url }}">
24{% else %}<link rel="shortcut icon" href="{{ 'img/favicon.ico'|url }}">{% endif %}
25{%- endblock %}
diff --git a/doc/md/Server-configuration.md b/doc/md/Server-configuration.md
index e281dc85..cf44ecf5 100644
--- a/doc/md/Server-configuration.md
+++ b/doc/md/Server-configuration.md
@@ -397,6 +397,7 @@ http {
397``` 397```
398 398
399## Proxies 399## Proxies
400
400If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set: 401If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set:
401 402
402- `X-Forwarded-Proto` 403- `X-Forwarded-Proto`
@@ -405,6 +406,12 @@ If Shaarli is served behind a proxy (i.e. there is a proxy server between client
405 406
406See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues. 407See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues.
407 408
409## Robots and crawlers
410
411Shaarli disallows indexing and crawling of your local documentation pages by search engines, using `<meta name="robots">` HTML tags.
412Your Shaarli instance and other pages you host may still be indexed by various robots on the public Internet.
413You may want to setup a robots.txt file or other crawler control mechanism on your server.
414See [[1]](https://en.wikipedia.org/wiki/Robots_exclusion_standard), [[2]](https://support.google.com/webmasters/answer/6062608?hl=en) and [[3]](https://developers.google.com/search/reference/robots_meta_tag)
408 415
409## See also 416## See also
410 417