document v2.1.2

Signed-off-by: Brian S. Stephan <bss@incorporeal.org>

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 Included is a summary of changes to the project, by version. Details can be found in the commit history.
 
+## v2.1.2
+
+### Features
+
+* An optional license declaration can be added to the footer, with a config "LICENSE" directive.
+
+### Improvements
+
+* Style changes in footnotes, hrs, table colors, footnote links, full width figures.
+* Have floats clear their side, to not have a waterfall/ratchet effect when too many floating things are next to each
+  other.
+* Add borders to the plain style tables.
+
+### Miscellaneous
+
+* One HTML tweak to make the W3C CSS validator happy.
+* Some old code from the pre-SSG days has been removed.
+
 ## v2.1.1
 
 ### Improvements

incorporealcms/markdown.py

@@ -135,11 +135,6 @@ def handle_markdown_file_path(path: str, pages_root: str) -> str:
     extra_footer = get_meta_str(md, 'footer') if md.Meta.get('footer') else None
     template_name = get_meta_str(md, 'template') if md.Meta.get('template') else 'base.html'
 
-    # check if this has a HTTP redirect
-    redirect_url = get_meta_str(md, 'redirect') if md.Meta.get('redirect') else None
-    if redirect_url:
-        raise NotImplementedError("redirects in markdown are unsupported!")
-
     template = jinja_env.get_template(template_name)
     return template.render(title=page_title,
                            config=Config,

incorporealcms/static/css/base.css

@@ -116,19 +116,26 @@ img {
     max-width: 75% !important;
 }
 
+.full-width {
+    max-width: 100%;
+}
+
 .img-center {
     display: block;
+    clear: both;
     margin-left: auto;
     margin-right: auto;
 }
 
 .img-left {
     float: left;
+    clear: left;
     margin-right: 1em;
 }
 
 .img-right {
     float: right;
+    clear: right;
     margin-left: 1em;
 }
 
@@ -144,12 +151,14 @@ figure {
 
 figure.right {
     float: right;
+    clear: right;
     margin-left: 10px;
     display: block;
 }
 
 figure.left {
     float: left;
+    clear: left;
     margin-right: 10px;
     display: block;
 }
@@ -164,14 +173,19 @@ figcaption {
     font-size: 0.9em;
 }
 
-.footnote {
+div.content .footnote {
     font-size: 0.8em;
 }
 
-.footnote p {
+div.content .footnote p {
     margin: 0;
 }
 
 .footnote-ref:link, .footnote-ref:visited, .footnote-ref:hover, .footnote-ref:active {
     font-weight: normal;
 }
+
+.footnote-ref {
+    font-size: 0.75em;
+    margin-left: 1px;
+}

incorporealcms/static/css/dark.css

@@ -14,11 +14,15 @@ body {
     background: #111;
 }
 
+hr {
+    color: #333;
+}
+
 h1, h2, h3, h4, h5, h6 {
     color: #B31D15;
 }
 
-p a, ul a, ol a {
+p a, ul a, ol a, sup a {
     color: #DDD;
 }
 
@@ -26,7 +30,7 @@ footer a {
     color: #999;
 }
 
-p a:hover, ul a:hover, ol a:hover, footer a:hover {
+p a:hover, ul a:hover, ol a:hover, footer a:hover, sup a:hover {
     color: #B31D15;
 }
 
@@ -44,7 +48,7 @@ table, th, td {
 }
 
 th {
-    background: #333;
+    background: #111;
 }
 
 blockquote {

incorporealcms/static/css/light.css

@@ -14,11 +14,15 @@ body {
     background: #EEE;
 }
 
+hr {
+    color: #CCC;
+}
+
 h1, h2, h3, h4, h5, h6 {
     color: #811610;
 }
 
-p a, ul a, ol a {
+p a, ul a, ol a, sup a {
     color: #222;
 }
 
@@ -26,7 +30,7 @@ footer a {
     color: #999;
 }
 
-p a:hover, ul a:hover, ol a:hover, footer a:hover {
+p a:hover, ul a:hover, ol a:hover, footer a:hover, sup a:hover {
     color: #811610;
 }
 
@@ -44,7 +48,7 @@ table, th, td {
 }
 
 th {
-    background: #CCC;
+    background: #EEE;
 }
 
 blockquote {

incorporealcms/static/css/plain.css

@@ -9,6 +9,10 @@ div.header {
     justify-content: space-between;
 }
 
+table, th, td {
+    border: 1px solid;
+}
+
 .img-25 {
     max-width: 25% !important;
 }

incorporealcms/templates/base.html

@@ -18,7 +18,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 <link rel="icon" href="{{ config.FAVICON }}">
 <link rel="alternate" type="application/atom+xml" href="/feed/atom">
 <link rel="alternate" type="application/rss+xml" href="/feed/rss">
-<script type="text/javascript" src="/static/js/style_switcher.js"></script>
+<script src="/static/js/style_switcher.js"></script>
 
 <div {% block site_class %}class="site-wrap site-wrap-normal-width"{% endblock %}>
     {% block header %}
@@ -44,7 +44,11 @@ SPDX-License-Identifier: GPL-3.0-or-later
     </div>
     <footer>
         {% if extra_footer %}<div class="extra-footer"><i>{{ extra_footer|safe }}</i></div>{% endif %}
-        <div class="footer"><i>Last modified: {{ mtime }}</i></div>
+        <div class="footer">
+            <i>Last modified: {{ mtime }}.<br />
+               {% if config.LICENSE %} Available via {{ config.LICENSE|safe }}{% endif %}.
+            </i>
+        </div>
     </footer>
     {% endblock %}
 </div>

tests/instance/broken/redirect.md

@@ -1 +0,0 @@
-Redirect:           http://www.google.com/

tests/test_markdown.py

@@ -103,12 +103,6 @@ def test_render_with_default_style_override():
                 in handle_markdown_file_path('index.md', PAGES_DIR)
 
 
-def test_redirects_error_unsupported():
-    """Test that we throw a warning about the barely-used Markdown redirect tag, which we can't support via SSG."""
-    with pytest.raises(NotImplementedError):
-        handle_markdown_file_path('redirect.md', os.path.join(INSTANCE_DIR, 'broken'))
-
-
 def test_instance_resource_path_to_request_path_on_index():
     """Test index.md -> /."""
     assert instance_resource_path_to_request_path('index.md') == '/'
@@ -217,3 +211,15 @@ def test_index_in_source_link_is_stripped():
     assert '<a href=".#anchor">Anchored This Index</a>' in content
     assert '<a href="../">Parent</a>' in content
     assert '<a href="../#anchor">Anchored Parent</a>' in content
+
+
+def test_license_link():
+    """Test that the config's license HTML is displayed in the footer."""
+    with patch('incorporealcms.Config.LICENSE',
+               '<a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>', create=True):
+        assert 'Available via <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>.'\
+            in handle_markdown_file_path('index.md', PAGES_DIR)
+
+    # default, no config
+    assert '<a href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>'\
+        not in handle_markdown_file_path('index.md', PAGES_DIR)