Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| dc81ef35de | |||
| c292f33334 | |||
| 1c052b8409 | |||
| 7cf8a427ce | |||
| e8a749d9ba | |||
| ae72fe87b5 | |||
| bb0e71e9e4 | |||
| 3bfdacdb6d | |||
| e6d2015de5 | |||
| 56eb767e33 | |||
| 07031fe667 | |||
| 48c6e8495a | |||
| 4f45943775 | |||
| b26ea6a661 | |||
| 1878d5951b | |||
| 829165ad8c | |||
| 7d982b96c9 | |||
| 5e41cde52e | |||
| ad33cf2e83 |
@@ -3,7 +3,6 @@ import logging
|
|||||||
import os
|
import os
|
||||||
from logging.config import dictConfig
|
from logging.config import dictConfig
|
||||||
|
|
||||||
import markdown
|
|
||||||
from flask import Flask, request, send_from_directory
|
from flask import Flask, request, send_from_directory
|
||||||
|
|
||||||
from ._version import get_versions
|
from ._version import get_versions
|
||||||
@@ -32,10 +31,6 @@ def create_app(instance_path=None, test_config=None):
|
|||||||
|
|
||||||
logger.debug("instance path: %s", app.instance_path)
|
logger.debug("instance path: %s", app.instance_path)
|
||||||
|
|
||||||
# initialize markdown parser from config, but include
|
|
||||||
# extensions our app depends on, like the meta extension
|
|
||||||
app.config['md'] = markdown.Markdown(extensions=app.config['MARKDOWN_EXTENSIONS'] + ['meta'])
|
|
||||||
|
|
||||||
@app.before_request
|
@app.before_request
|
||||||
def log_request():
|
def log_request():
|
||||||
logger.info("REQUEST: %s %s", request.method, request.path)
|
logger.info("REQUEST: %s %s", request.method, request.path)
|
||||||
|
|||||||
@@ -32,7 +32,21 @@ class Config(object):
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
MARKDOWN_EXTENSIONS = ['mdx_linkify', 'tables']
|
MARKDOWN_EXTENSIONS = ['extra', 'mdx_linkify', 'smarty', 'tables']
|
||||||
|
MARKDOWN_EXTENSION_CONFIGS = {
|
||||||
|
'extra': {
|
||||||
|
'attr_list': {},
|
||||||
|
'footnotes': {
|
||||||
|
'UNIQUE_IDS': True,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
'smarty': {
|
||||||
|
'smart_dashes': True,
|
||||||
|
'smart_quotes': False,
|
||||||
|
'smart_angled_quotes': False,
|
||||||
|
'smart_ellipses': True,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
DEFAULT_PAGE_STYLE = 'light'
|
DEFAULT_PAGE_STYLE = 'light'
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,21 @@
|
|||||||
"""Miscellaneous helper functions and whatnot."""
|
"""Miscellaneous helper functions and whatnot."""
|
||||||
|
import markdown
|
||||||
from flask import current_app as app
|
from flask import current_app as app
|
||||||
|
|
||||||
|
|
||||||
def get_meta_str(key):
|
def get_meta_str(md, key):
|
||||||
"""Provide the page's metadata for the specified key, or '' if unset."""
|
"""Provide the page's (parsed in Markup obj md) metadata for the specified key, or '' if unset."""
|
||||||
return " ".join(app.config['md'].Meta.get(key)) if app.config['md'].Meta.get(key) else ""
|
return " ".join(md.Meta.get(key)) if md.Meta.get(key) else ""
|
||||||
|
|
||||||
|
|
||||||
|
def init_md():
|
||||||
|
"""Initialize the Markdown parser.
|
||||||
|
|
||||||
|
This used to done at the app level in __init__, but extensions like footnotes apparently
|
||||||
|
assume the parser to only live for the length of parsing one document, and create double
|
||||||
|
footnote ref links if the one parser sees the same document multiple times.
|
||||||
|
"""
|
||||||
|
# initialize markdown parser from config, but include
|
||||||
|
# extensions our app depends on, like the meta extension
|
||||||
|
return markdown.Markdown(extensions=app.config['MARKDOWN_EXTENSIONS'] + ['meta'],
|
||||||
|
extension_configs=app.config['MARKDOWN_EXTENSION_CONFIGS'])
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ from flask import current_app as app
|
|||||||
from flask import make_response, redirect, render_template, request
|
from flask import make_response, redirect, render_template, request
|
||||||
from tzlocal import get_localzone
|
from tzlocal import get_localzone
|
||||||
|
|
||||||
from incorporealcms.lib import get_meta_str
|
from incorporealcms.lib import get_meta_str, init_md
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -34,11 +34,12 @@ def display_page(path):
|
|||||||
logger.warning("requested path '%s' (resolved path '%s') not found!", path, resolved_path)
|
logger.warning("requested path '%s' (resolved path '%s') not found!", path, resolved_path)
|
||||||
abort(404)
|
abort(404)
|
||||||
else:
|
else:
|
||||||
content = Markup(app.config['md'].convert(entry))
|
md = init_md()
|
||||||
logger.debug("file metadata: %s", app.config['md'].Meta)
|
content = Markup(md.convert(entry))
|
||||||
|
logger.debug("file metadata: %s", md.Meta)
|
||||||
|
|
||||||
return render('base.html', title=get_meta_str('title'), description=get_meta_str('description'),
|
return render('base.html', title=get_meta_str(md, 'title'), description=get_meta_str(md, 'description'),
|
||||||
image=get_meta_str('image'), base_url=request.base_url, content=content, navs=parent_navs,
|
image=get_meta_str(md, 'image'), base_url=request.base_url, content=content, navs=parent_navs,
|
||||||
mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
|
mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
|
||||||
|
|
||||||
|
|
||||||
@@ -111,6 +112,8 @@ def generate_parent_navs(path):
|
|||||||
else:
|
else:
|
||||||
with app.open_instance_resource(resolved_path, 'r') as entry_file:
|
with app.open_instance_resource(resolved_path, 'r') as entry_file:
|
||||||
entry = entry_file.read()
|
entry = entry_file.read()
|
||||||
_ = Markup(app.config['md'].convert(entry))
|
# for issues regarding parser reuse (see lib.init_md) we reinitialize the parser here
|
||||||
page_name = " ".join(app.config['md'].Meta.get('title')) if app.config['md'].Meta.get('title') else f'/{path}'
|
md = init_md()
|
||||||
|
_ = Markup(md.convert(entry))
|
||||||
|
page_name = " ".join(md.Meta.get('title')) if md.Meta.get('title') else f'/{path}'
|
||||||
return generate_parent_navs(parent_path) + [(page_name, f'/{path}')]
|
return generate_parent_navs(parent_path) + [(page_name, f'/{path}')]
|
||||||
|
|||||||
@@ -1,11 +1,15 @@
|
|||||||
html {
|
html {
|
||||||
color: #DDD;
|
color: #CCC;
|
||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
background: black;
|
background: black;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
strong {
|
||||||
|
color: #EEE;
|
||||||
|
}
|
||||||
|
|
||||||
.site-wrap {
|
.site-wrap {
|
||||||
background: #111;
|
background: #111;
|
||||||
|
|
||||||
@@ -25,16 +29,19 @@ a:link, a:visited {
|
|||||||
|
|
||||||
a:hover, a:active {
|
a:hover, a:active {
|
||||||
color: #B31D15;
|
color: #B31D15;
|
||||||
border-bottom: 1px dotted #EEE;
|
border-bottom: 1px dotted #B31D15;
|
||||||
}
|
}
|
||||||
|
|
||||||
section.nav, section.styles {
|
div.header {
|
||||||
color: #BBB;
|
|
||||||
background: #222;
|
background: #222;
|
||||||
border-bottom: 1px solid #222;
|
border-bottom: 1px solid #222;
|
||||||
}
|
}
|
||||||
|
|
||||||
section.nav a, section.styles a {
|
div.nav, div.styles {
|
||||||
|
color: #BBB;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.nav a, div.styles a {
|
||||||
color: #BBB;
|
color: #BBB;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -51,6 +58,11 @@ blockquote {
|
|||||||
border: 1px solid #222;
|
border: 1px solid #222;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.img-frame {
|
||||||
|
background-color: rgba(255, 255, 255, 0.1);
|
||||||
|
border: 1px solid #333;
|
||||||
|
}
|
||||||
|
|
||||||
figure {
|
figure {
|
||||||
background: #222;
|
background: #222;
|
||||||
border: 1px solid #333;
|
border: 1px solid #333;
|
||||||
|
|||||||
@@ -3,7 +3,11 @@ html {
|
|||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
background: #888;
|
background: #999;
|
||||||
|
}
|
||||||
|
|
||||||
|
strong {
|
||||||
|
color: #111;
|
||||||
}
|
}
|
||||||
|
|
||||||
.site-wrap {
|
.site-wrap {
|
||||||
@@ -25,16 +29,19 @@ a:link, a:visited {
|
|||||||
|
|
||||||
a:hover, a:active {
|
a:hover, a:active {
|
||||||
color: #811610;
|
color: #811610;
|
||||||
border-bottom: 1px dotted #111;
|
border-bottom: 1px dotted #811610;
|
||||||
}
|
}
|
||||||
|
|
||||||
section.nav, section.styles {
|
div.header {
|
||||||
color: #666;
|
|
||||||
background: #EEE;
|
background: #EEE;
|
||||||
border-bottom: 1px solid #CCC;
|
border-bottom: 1px solid #CCC;
|
||||||
}
|
}
|
||||||
|
|
||||||
section.nav a, section.styles a {
|
div.nav, div.styles {
|
||||||
|
color: #666;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.nav a, div.styles a {
|
||||||
color: #666;
|
color: #666;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -51,6 +58,11 @@ blockquote {
|
|||||||
border: 1px solid #CCC;
|
border: 1px solid #CCC;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.img-frame {
|
||||||
|
background-color: rgba(0, 0, 0, 0.1);
|
||||||
|
border: 1px solid #BBB;
|
||||||
|
}
|
||||||
|
|
||||||
figure {
|
figure {
|
||||||
background: #EFEFEF;
|
background: #EFEFEF;
|
||||||
border: 1px solid #CCCCCC;
|
border: 1px solid #CCCCCC;
|
||||||
|
|||||||
@@ -63,27 +63,36 @@ a:active {
|
|||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
section.nav, section.styles {
|
div.header {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.nav, div.styles {
|
||||||
font-size: 0.75em;
|
font-size: 0.75em;
|
||||||
border-bottom: 1px solid #444;
|
|
||||||
padding: 0.25em 0.5em;
|
padding: 0.25em 0.5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
section.nav a, section.styles a {
|
div.nav a, div.styles a {
|
||||||
border-bottom: none;
|
border-bottom: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
section.styles {
|
div.content {
|
||||||
float: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
section.content {
|
|
||||||
font-size: 11pt;
|
font-size: 11pt;
|
||||||
|
|
||||||
padding: 0 1em;
|
padding: 0 1em;
|
||||||
line-height: 1.5em;
|
line-height: 1.5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
sup, sub {
|
||||||
|
vertical-align: baseline;
|
||||||
|
position: relative;
|
||||||
|
top: -0.4em;
|
||||||
|
}
|
||||||
|
sub {
|
||||||
|
top: 0.4em;
|
||||||
|
}
|
||||||
|
|
||||||
footer {
|
footer {
|
||||||
display: block;
|
display: block;
|
||||||
font-size: 75%;
|
font-size: 75%;
|
||||||
@@ -114,14 +123,38 @@ blockquote {
|
|||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.splash img {
|
img {
|
||||||
max-width: 100%;
|
max-width: 100%;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.img-25 {
|
||||||
|
max-width: 25% !important;
|
||||||
|
}
|
||||||
|
|
||||||
.img-50 {
|
.img-50 {
|
||||||
max-width: 50% !important;
|
max-width: 50% !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.img-center {
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-left {
|
||||||
|
float: left;
|
||||||
|
margin-right: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-right {
|
||||||
|
float: right;
|
||||||
|
margin-left: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-frame {
|
||||||
|
padding: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
/* For screens with width smaller than 400px */
|
/* For screens with width smaller than 400px */
|
||||||
.figure-left .figure-right {
|
.figure-left .figure-right {
|
||||||
max-width: 95%;
|
max-width: 95%;
|
||||||
@@ -173,3 +206,12 @@ figcaption {
|
|||||||
margin: 5px;
|
margin: 5px;
|
||||||
display: inline;
|
display: inline;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.footnote {
|
||||||
|
font-size: 0.75em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footnote-ref:link, .footnote-ref:visited, .footnote-ref:hover, .footnote-ref:active {
|
||||||
|
border-bottom: none;
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
<!doctype html>
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
<title>{{ title }}{% if title %} - {% endif %}{{ config.TITLE_SUFFIX }}</title>
|
<title>{{ title }}{% if title %} - {% endif %}{{ config.TITLE_SUFFIX }}</title>
|
||||||
{% if title %}<meta property="og:title" content="{{ title }}">{% endif %}
|
{% if title %}<meta property="og:title" content="{{ title }}">{% endif %}
|
||||||
{% if description %}<meta property="og:description" content="{{ description }}">{% endif %}
|
{% if description %}<meta property="og:description" content="{{ description }}">{% endif %}
|
||||||
@@ -10,21 +11,24 @@
|
|||||||
<link rel="stylesheet" href="{{ url_for('static', filename=user_style) }}">
|
<link rel="stylesheet" href="{{ url_for('static', filename=user_style) }}">
|
||||||
<link rel="icon" href="{{ url_for('static', filename='img/favicon.png') }}">
|
<link rel="icon" href="{{ url_for('static', filename='img/favicon.png') }}">
|
||||||
|
|
||||||
<section class="site-wrap">
|
<div class="site-wrap">
|
||||||
<section class="styles">
|
<div class="header">
|
||||||
<a href="?style=dark">[dark]</a>
|
<div class="nav">
|
||||||
<a href="?style=light">[light]</a>
|
{% for nav in navs %}
|
||||||
</section>
|
<a href="{{ nav.1 }}">{{ nav.0 }}</a>
|
||||||
<section class="nav">
|
{% if not loop.last %} » {% endif %}
|
||||||
{% for nav in navs %}
|
{% endfor %}
|
||||||
<a href="{{ nav.1 }}">{{ nav.0 }}</a>
|
</div>
|
||||||
{% if not loop.last %} » {% endif %}
|
<div class="styles">
|
||||||
{% endfor %}
|
<a href="?style=dark">[dark]</a>
|
||||||
</section>
|
<a href="?style=light">[light]</a>
|
||||||
<section class="content">
|
</div>
|
||||||
{{ content }}
|
</div>
|
||||||
</section>
|
<div class="content">
|
||||||
|
{{ content }}
|
||||||
|
</div>
|
||||||
<footer>
|
<footer>
|
||||||
<i>Last modified: {{ mtime }}</i>
|
<i>Last modified: {{ mtime }}</i>
|
||||||
</footer>
|
</footer>
|
||||||
</section>
|
</div>
|
||||||
|
</html>
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ pytest
|
|||||||
pytest-cov
|
pytest-cov
|
||||||
|
|
||||||
# linting and other static code analysis
|
# linting and other static code analysis
|
||||||
bandit
|
bandit==1.6.2 # pinned because 1.7.0 wasn't running right in tox
|
||||||
dlint
|
dlint
|
||||||
flake8
|
flake8
|
||||||
flake8-blind-except
|
flake8-blind-except
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ appdirs==1.4.4
|
|||||||
# via virtualenv
|
# via virtualenv
|
||||||
attrs==20.3.0
|
attrs==20.3.0
|
||||||
# via pytest
|
# via pytest
|
||||||
bandit==1.7.0
|
bandit==1.6.2
|
||||||
# via -r requirements/requirements-dev.in
|
# via -r requirements/requirements-dev.in
|
||||||
bleach==3.2.2
|
bleach==3.2.2
|
||||||
# via mdx-linkify
|
# via mdx-linkify
|
||||||
|
|||||||
@@ -23,20 +23,24 @@ def test_markdown_meta_extension_always():
|
|||||||
assert b'<title>Index - incorporeal.org</title>' in response.data
|
assert b'<title>Index - incorporeal.org</title>' in response.data
|
||||||
|
|
||||||
|
|
||||||
def test_extra_markdown_extensions_work():
|
def test_custom_markdown_extensions_work():
|
||||||
"""Test we can load more extensions via config, and that they work."""
|
"""Test we can change extensions via config, and that they work.
|
||||||
|
|
||||||
|
This used to test smarty, but that's added by default now, so we test
|
||||||
|
that it can be removed by overriding the option.
|
||||||
|
"""
|
||||||
app = create_app(instance_path=os.path.join(HERE, 'instance'))
|
app = create_app(instance_path=os.path.join(HERE, 'instance'))
|
||||||
client = app.test_client()
|
client = app.test_client()
|
||||||
response = client.get('/mdash-or-triple-dash')
|
response = client.get('/mdash-or-triple-dash')
|
||||||
assert response.status_code == 200
|
assert response.status_code == 200
|
||||||
assert b'word --- word' in response.data
|
assert b'word — word' in response.data
|
||||||
|
|
||||||
app = create_app(instance_path=os.path.join(HERE, 'instance'),
|
app = create_app(instance_path=os.path.join(HERE, 'instance'),
|
||||||
test_config={'MARKDOWN_EXTENSIONS': ['smarty']})
|
test_config={'MARKDOWN_EXTENSIONS': []})
|
||||||
client = app.test_client()
|
client = app.test_client()
|
||||||
response = client.get('/mdash-or-triple-dash')
|
response = client.get('/mdash-or-triple-dash')
|
||||||
assert response.status_code == 200
|
assert response.status_code == 200
|
||||||
assert b'word — word' in response.data
|
assert b'word --- word' in response.data
|
||||||
|
|
||||||
|
|
||||||
def test_title_override():
|
def test_title_override():
|
||||||
|
|||||||
Reference in New Issue
Block a user