Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #1220 from nodiscc/doc-robots-noindex-nofollow

Browse source 
add "noindex, nofollow" HTML robots meta-tag to documentation pages
This commit is contained in:
nodiscc 2018-10-03 19:29:20 +00:00 committed by GitHub
commit 10a7b5cee9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 35 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
doc/custom_theme/main.html Normal file
View file

@ -0,0 +1,25 @@
{% extends "base.html" %}
{#
The entry point for the ReadTheDocs Theme.
Any theme customisations should override this file to redefine blocks defined in
the various templates. The custom theme should only need to define a main.html
which `{% extends "base.html" %}` and defines various blocks which will replace
the blocks defined in base.html and its included child templates.
#}
{%- block site_meta %}
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{%- if 'media.readthedocs.org' not in config.extra_css[0] %}
<meta name="robots" content="noindex, nofollow">
{%- endif %}
{% if page and page.is_homepage %}<meta name="description" content="{{ config.site_description }}">{% endif %}
{% if config.site_author %}<meta name="author" content="{{ config.site_author }}">{% endif %}
{% if config.site_favicon %}<link rel="shortcut icon" href="{{ config.site_favicon|url }}">
{% else %}<link rel="shortcut icon" href="{{ 'img/favicon.ico'|url }}">{% endif %}
{%- endblock %}

7
doc/md/Server-configuration.md
View file

@ -397,6 +397,7 @@ http {
``` ```
## Proxies ## Proxies
If 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: If 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:
- `X-Forwarded-Proto` - `X-Forwarded-Proto`
@ -405,6 +406,12 @@ If Shaarli is served behind a proxy (i.e. there is a proxy server between client
See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues. See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues.
## Robots and crawlers
Shaarli disallows indexing and crawling of your local documentation pages by search engines, using `<meta name="robots">` HTML tags.
Your Shaarli instance and other pages you host may still be indexed by various robots on the public Internet.
You may want to setup a robots.txt file or other crawler control mechanism on your server.
See [[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)
## See also ## See also

4
mkdocs.yml
View file

@ -2,7 +2,9 @@ site_name: Shaarli Documentation
repo_url: https://github.com/shaarli/Shaarli repo_url: https://github.com/shaarli/Shaarli
edit_uri: edit/master/doc/md edit_uri: edit/master/doc/md
site_description: The personal, minimalist, super-fast, database free, bookmarking service site_description: The personal, minimalist, super-fast, database free, bookmarking service
theme: readthedocs theme:
name: readthedocs
custom_dir: doc/custom_theme/
docs_dir: doc/md docs_dir: doc/md
site_dir: doc/html site_dir: doc/html
# Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings: # Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings: