Update docs for Nikola v7.8.5

getnikola · May 20, 2017 · 2abb679 · 2abb679
1 parent 4ddce56
commit 2abb679
Show file tree

Hide file tree

Showing 14 changed files with 167 additions and 93 deletions.
diff --git a/files/assets/css/custom.css b/files/assets/css/custom.css
@@ -127,5 +127,22 @@ code.gs-code {
 }
 
 /* Header permalinks */
-.headerlink { color: #ddd; margin-left: 0.2em; }
-.headerlink:hover { opacity: 1; background: #ddd; color: #000; text-decoration: none; }
+h1:hover .headerlink, h2:hover .headerlink,
+h3:hover .headerlink, h4:hover .headerlink,
+h5:hover .headerlink, h6:hover .headerlink {
+    display: inline;
+}
+
+.headerlink {
+    display: none;
+    color: #ddd;
+    margin-left: 0.2em;
+    padding: 0 0.2em;
+}
+
+.headerlink:hover {
+    opacity: 1;
+    background: #ddd;
+    color: #000;
+    text-decoration: none;
+}
diff --git a/listings/conf.py b/listings/conf.py
@@ -320,6 +320,12 @@
 # are the default and will apply GENERATE_ATOM if set.
 # POSTS_SECTIONS_ARE_INDEXES = True
 
+# Final locations are:
+# output / TRANSLATION[lang] / SECTION_PATH / SECTION_NAME / index.html (list of posts for a section)
+# output / TRANSLATION[lang] / SECTION_PATH / SECTION_NAME / rss.xml (RSS feed for a section)
+# (translatable)
+# SECTION_PATH = ""
+
 # Each post and section page will have an associated color that can be used
 # to style them with a recognizable color detail across your site. A color
 # is assigned to  each section based on shifting the hue of your THEME_COLOR
@@ -824,45 +830,13 @@
 # Color scheme to be used for code blocks. If your theme provides
 # "assets/css/code.css" this is ignored. Leave empty to disable.
 # Can be any of:
-# algol
-# algol_nu
-# arduino
-# autumn
-# borland
-# bw
-# colorful
-# default
-# emacs
-# friendly
-# fruity
-# igor
-# lovelace
-# manni
-# monokai
-# murphy
-# native
-# paraiso_dark
-# paraiso_light
-# pastie
-# perldoc
-# rrt
-# tango
-# trac
-# vim
-# vs
-# xcode
+# algol, algol_nu, autumn, borland, bw, colorful, default, emacs, friendly,
+# fruity, igor, lovelace, manni, monokai, murphy, native, paraiso-dark,
+# paraiso-light, pastie, perldoc, rrt, tango, trac, vim, vs, xcode
 # This list MAY be incomplete since pygments adds styles every now and then.
+# Check with list(pygments.styles.get_all_styles()) in an interpreter.
 # CODE_COLOR_SCHEME = 'default'
 
-# If you use 'site-reveal' theme you can select several subthemes
-# THEME_REVEAL_CONFIG_SUBTHEME = 'sky'
-# You can also use: beige/serif/simple/night/default
-
-# Again, if you use 'site-reveal' theme you can select several transitions
-# between the slides
-# THEME_REVEAL_CONFIG_TRANSITION = 'cube'
-# You can also use: page/concave/linear/none/default
-
 # FAVICONS contains (name, file, size) tuples.
 # Used to create favicon link like this:
 # <link rel="name" href="file" sizes="size"/>
@@ -883,6 +857,7 @@
 # {min_remaining_read}          The string “{remaining_reading_time} min remaining to read” in the current language.
 # {paragraph_count}             The amount of paragraphs in the post.
 # {remaining_paragraph_count}   The amount of paragraphs in the post, sans the teaser.
+# {post_title}                  The title of the post.
 # {{                            A literal { (U+007B LEFT CURLY BRACKET)
 # }}                            A literal } (U+007D RIGHT CURLY BRACKET)
 
@@ -1026,7 +1001,8 @@
 # Do you want a add a Mathjax config file?
 # MATHJAX_CONFIG = ""
 
-# If you are using the compile-ipynb plugin, just add this one:
+# If you want support for the $.$ syntax (which may conflict with running
+# text!), just use this config:
 # MATHJAX_CONFIG = """
 # <script type="text/x-mathjax-config">
 # MathJax.Hub.Config({
@@ -1035,23 +1011,20 @@
 #         displayMath: [ ['$$','$$'], ["\\\[","\\\]"] ],
 #         processEscapes: true
 #     },
-#     displayAlign: 'left', // Change this to 'center' to center equations.
+#     displayAlign: 'center', // Change this to 'left' if you want left-aligned equations.
 #     "HTML-CSS": {
 #         styles: {'.MathJax_Display': {"margin": 0}}
 #     }
 # });
 # </script>
 # """
 
-# Want to use KaTeX instead of MathJax? While KaTeX is less featureful,
-# it's faster and the output looks better.
-# If you set USE_KATEX to True, you also need to add an extra CSS file
-# like this:
-# EXTRA_HEAD_DATA = """<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.6.0/katex.min.css">"""
+# Want to use KaTeX instead of MathJax? While KaTeX may not support every
+# feature yet, it's faster and the output looks better.
 # USE_KATEX = False
 
-# If you want to use the old (buggy) inline math $.$ with KaTeX, then
-# you might want to use this feature.
+# KaTeX auto-render settings. If you want support for the $.$ syntax (wihch may
+# conflict with running text!), just use this config:
 # KATEX_AUTO_RENDER = """
 # delimiters: [
 #     {left: "$$", right: "$$", display: true},
@@ -1075,7 +1048,7 @@
 # The default is ['fenced_code', 'codehilite']
 MARKDOWN_EXTENSIONS = ['fenced_code', 'codehilite', 'extra']
 
-# Extra options to pass to the pandoc comand.
+# Extra options to pass to the pandoc command.
 # by default, it's empty, is a list of strings, for example
 # ['-F', 'pandoc-citeproc', '--bibliography=/Users/foo/references.bib']
 # Pandoc does not demote headers by default.  To enable this, you can use, for example
@@ -1124,11 +1097,11 @@
 # between each other. Old Atom feeds with no changes are marked as archived.
 # GENERATE_ATOM = False
 
-# Only inlclude teasers in Atom and RSS feeds. Disabling include the full
+# Only include teasers in Atom and RSS feeds. Disabling include the full
 # content. Defaults to True.
 # FEED_TEASERS = True
 
-# Strip HTML from Atom annd RSS feed summaries and content. Defaults to False.
+# Strip HTML from Atom and RSS feed summaries and content. Defaults to False.
 # FEED_PLAIN = False
 
 # Number of posts in Atom and RSS feeds.

diff --git a/state_data.json b/state_data.json
@@ -1,3 +1,3 @@
 {
-  "last_deploy": "2017-05-17T23:23:04.729769"
+  "last_deploy": "2017-05-20T13:01:23.214578"
 }
diff --git a/stories/AUTHORS.txt b/stories/AUTHORS.txt
@@ -27,7 +27,6 @@
 * `Daniel F. Moisset <https://github.com/dmoisset>`_
 * `Daniel Harding <https://github.com/living180>`_
 * `dastagg <https://github.com/dastagg>`_
-* `dastagg <https://github.com/dastagg>`_
 * `David Barragán Merino <https://github.com/bameda>`_
 * `David Beath <https://github.com/DBeath>`_
 * `Dhruv Baldawa <https://github.com/dhruvbaldawa>`_
@@ -45,8 +44,10 @@
 * `Felix Schwarz <https://github.com/FelixSchwarz>`_
 * `Florian Finkernagel <https://github.com/TyberiusPrime>`_
 * `follower <https://github.com/follower>`_
+* `George Leslie-Waksman <https://github.com/gwax>`_
 * `Grzegorz Śliwiński <https://github.com/fizyk>`_
 * `Guillermo O. Freschi <https://github.com/Tordek>`_
+* `h4ckninja <https://github.com/h4ckninja>`_
 * `Hardening <https://github.com/hardening>`_
 * `Hong Xu <https://www.topbug.net>`_
 * `Ivan Teoh <https://github.com/ivanteoh>`_

diff --git a/stories/CHANGES.txt b/stories/CHANGES.txt
@@ -1,3 +1,53 @@
+New in v7.8.5
+=============
+
+Math support changes
+--------------------
+
+* If you edited templates related to indexes and posts (``index.tmpl``,
+  ``post.tmpl``, ``index_helper.tmpl``, ``post_helper.tmpl``) in your
+  templates, you should adjust them to use ``math_helper.tmpl``.
+* If you are using KaTeX, you should remove the CSS snippet from your
+  configuration (templates), as that is now handled by Nikola.
+
+Features
+--------
+
+* Get rid of ``THEME_REVEAL_CONFIG_*`` settings, use global context
+  instead (Issue #2485)
+* New emoji shortcode
+* Add ``SECTION_PATH`` support to move the section indexes to a
+  user-defined location (Issue #2738)
+* Add a list of template variables to documentation (Issues #2328,
+  #2712, #2259) and update the theming reference (Issue #2259)
+* Add ``{post_title}`` tag for Read More links (Issue #2709)
+* Include MathJax config only when needed (via Issue #2715)
+* Include KaTeX CSS automatically when needed (Issue #2715)
+* Split out math code into new ``math_helper.tmpl`` template (Issue
+  #2715)
+* Added ``jpegoptim_progressive`` filter to convert jpeg images to progressive
+  jpegs.
+
+Bugfixes
+--------
+
+* Open ``127.0.0.1`` when using ``nikola serve -b`` and default
+  ``0.0.0.0`` hostname to avoid resolution issues — the site is still
+  available on all interfaces (Issue #2755)
+* Don't break animated GIFs in postprocessing (Issue #2750)
+* More robust shortcodes, no need to escape URLs in reSt, work better
+  with LaTeX, etc.
+* No longer creates empty subarchive pages, and no longer create broken
+  archive navigation links on day level (Issue #2734)
+* Fixes post scanner plugin order (Issue #2720)
+* Rename ``POSTS_SECTION_ARE_INDEXES`` to ``POSTS_SECTIONS_ARE_INDEXES``
+* Make date ranges work in shortcode-based post lists (Issue #2690)
+* Read data files only if Nikola configuration exists (Issue #2708)
+* Make ``PAGE_INDEX`` work with ``PRETTY_URLS`` (Issue #2705)
+* Fix PHP posts/pages not rendering on Windows (Issue #2706)
+* Improving support for PostScanner plugins by asking them which compilers
+  are unused (Issue #2496)
+
 New in v7.8.4
 =============
 

diff --git a/stories/conf.txt b/stories/conf.txt
@@ -1,11 +1,11 @@
-.. title: Nikola v7.8.4 configuration file
+.. title: Nikola v7.8.5 configuration file
 .. slug: conf
 .. date: 2014-11-08 18:51:30 UTC
 .. description: The Nikola configuration file.
 .. type: text
 .. author: The Nikola Team
 
-The default config file for Nikola v7.8.4 is reproduced below.
+The default config file for Nikola v7.8.5 is reproduced below.
 
 .. raw:: html
 

diff --git a/stories/extending.txt b/stories/extending.txt
@@ -9,7 +9,7 @@
 Extending Nikola
 ================
 
-:Version: 7.8.4
+:Version: 7.8.5
 :Author: Roberto Alsina <ralsina@netmanagers.com.ar>
 
 .. class:: alert alert-info pull-right

diff --git a/stories/internals.txt b/stories/internals.txt
@@ -85,8 +85,8 @@ one of the existing ones.
 .. sidebar:: Tests
 
     While Nikola is not a hardcore TDD project, we like tests. So, please add them if you can.
-    You can do doctests, you can do unit tests, you can do integration tests. There is support
-    for all of them.
+    You can write unit tests or integration tests. (Doctests are not supported
+    anymore due to fragility.)
 
 Posts and Pages
 ---------------