Disable <base> tag by default (#2471)

* Ask users to enable GitHub Pages in deployment tutorial * Disable <base> tag by default * Changelog for #2471
getnikola · Aug 24, 2016 · 1591e27 · 1591e27
1 parent 8d52ca1
commit 1591e27
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -18,6 +18,8 @@ Features
 Bugfixes
 --------
 
+* Remove the (useless) ``<base>`` tag by default; change conf.py to
+  opt in (Issue #2471)
 * Show tag descriptions when TAG_PAGES_ARE_INDEXES is True (Issue #2444)
 * Record template dependencies for post-list shortcut (Issue #2451)
 * Default to English for docutils messages if no translations exist

diff --git a/nikola/conf.py.in b/nikola/conf.py.in
@@ -434,9 +434,12 @@ FRONT_INDEX_HEADER = {
 # If USE_BASE_TAG is True, then all HTML files will include
 # something like <base href=http://foo.var.com/baz/bat> to help
 # the browser resolve relative links.
-# In some rare cases, this will be a problem, and you can
-# disable it by setting USE_BASE_TAG to False.
-# USE_BASE_TAG = True
+# Most people don’t need this tag; major websites don’t use it. Use
+# only if you know what you’re doing. If this is True, your website
+# will not be fully usable by manually opening .html files in your web
+# browser (`nikola serve` or `nikola auto` is mandatory). Also, if you
+# have mirrors of your site, they will point to SITE_URL everywhere.
+USE_BASE_TAG = False
 
 # Final location for the blog main RSS feed is:
 # output / TRANSLATION[lang] / RSS_PATH / rss.xml

diff --git a/nikola/nikola.py b/nikola/nikola.py
@@ -561,7 +561,7 @@ def __init__(self, **config):
             'THUMBNAIL_SIZE': 180,
             'UNSLUGIFY_TITLES': False,  # WARNING: conf.py.in overrides this with True for backwards compatibility
             'URL_TYPE': 'rel_path',
-            'USE_BASE_TAG': True,
+            'USE_BASE_TAG': False,
             'USE_BUNDLES': True,
             'USE_CDN': False,
             'USE_CDN_WARNING': True,