Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
9d87aab61b
|
|||
|
35ea94185b
|
|||
|
69feb0c29c
|
|||
|
788a9cbaba
|
|||
| be6d96273c | |||
| a700470067 | |||
| 8a62167cea | |||
| 4ea824e86f | |||
| 28dbfd45b5 |
13
README.md
13
README.md
@@ -35,6 +35,19 @@ Put content inside `env-py3.8/var/incorporealcms-instance/pages/` and go.
|
||||
|
||||
Care is taken to not serve content above the `pages/` dir, even via symlink.
|
||||
|
||||
## Configuration
|
||||
|
||||
I've tried to keep the software agnostic to my personal domains, logos, etc. There are some settings
|
||||
you are probably interested in tweaking, by specifying new values in
|
||||
`incorporealcms-instance/config.py`:
|
||||
|
||||
* `TITLE_SUFFIX` is appended to the title of every page, separated from other title content by a
|
||||
dash.
|
||||
* `CONTACT_EMAIL` is referred to in error templates.
|
||||
* `FAVICON` supplies the image used in browser tabs and that kind of thing.
|
||||
|
||||
If I missed anything, please let me know.
|
||||
|
||||
## Author and Licensing
|
||||
|
||||
Written by and copyright Brian S. Stephan (bss@incorporeal.org).
|
||||
|
||||
@@ -52,7 +52,7 @@ class Config(object):
|
||||
|
||||
# customizations
|
||||
DEFAULT_PAGE_STYLE = 'light'
|
||||
TITLE_SUFFIX = 'incorporeal.org'
|
||||
CONTACT_EMAIL = 'bss@incorporeal.org'
|
||||
TITLE_SUFFIX = 'example.com'
|
||||
CONTACT_EMAIL = 'admin@example.com'
|
||||
|
||||
# specify FAVICON in your instance config.py to override the suou icon
|
||||
# specify FAVICON in your instance config.py to override the provided icon
|
||||
|
||||
@@ -12,10 +12,9 @@ logger = logging.getLogger(__name__)
|
||||
class InlinePydot(markdown.Extension):
|
||||
"""Wrap the markdown prepcoressor."""
|
||||
|
||||
def extendMarkdown(self, md, md_globals):
|
||||
def extendMarkdown(self, md):
|
||||
"""Add InlinePydotPreprocessor to the Markdown instance."""
|
||||
md.registerExtension(self)
|
||||
md.preprocessors.add('dot_block', InlinePydotPreprocessor(md), '_begin')
|
||||
md.preprocessors.register(InlinePydotPreprocessor(md), 'dot_block', 100)
|
||||
|
||||
|
||||
class InlinePydotPreprocessor(markdown.preprocessors.Preprocessor):
|
||||
|
||||
@@ -58,6 +58,7 @@ div.header a {
|
||||
}
|
||||
|
||||
div.content {
|
||||
font-size: 11pt;
|
||||
padding: 0 1em;
|
||||
line-height: 1.5em;
|
||||
}
|
||||
@@ -114,6 +115,10 @@ img {
|
||||
max-width: 50% !important;
|
||||
}
|
||||
|
||||
.img-75 {
|
||||
max-width: 75% !important;
|
||||
}
|
||||
|
||||
.img-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
/* common styling via the base.css, used in light and dark */
|
||||
@import '/static/css/base.css';
|
||||
|
||||
html {
|
||||
color: #CCC;
|
||||
color: #DDD;
|
||||
}
|
||||
|
||||
body {
|
||||
background: black;
|
||||
background: #090909;
|
||||
}
|
||||
|
||||
strong {
|
||||
@@ -13,7 +14,7 @@ strong {
|
||||
}
|
||||
|
||||
.site-wrap {
|
||||
background: #111;
|
||||
background: black;
|
||||
|
||||
border: 1px solid #222;
|
||||
border-top: none;
|
||||
@@ -61,12 +62,3 @@ blockquote {
|
||||
background-color: rgba(255, 255, 255, 0.1);
|
||||
border: 1px solid #333;
|
||||
}
|
||||
|
||||
figure {
|
||||
background: #222;
|
||||
border: 1px solid #333;
|
||||
}
|
||||
|
||||
figcaption {
|
||||
color: #BBB;
|
||||
}
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* common styling via the base.css, used in light and dark */
|
||||
@import '/static/css/base.css';
|
||||
|
||||
html {
|
||||
@@ -5,7 +6,7 @@ html {
|
||||
}
|
||||
|
||||
body {
|
||||
background: #999;
|
||||
background: #F6F6F6;
|
||||
}
|
||||
|
||||
strong {
|
||||
@@ -15,7 +16,7 @@ strong {
|
||||
.site-wrap {
|
||||
background: white;
|
||||
|
||||
border: 1px solid #ddd;
|
||||
border: 1px solid #DDD;
|
||||
border-top: none;
|
||||
border-bottom: none;
|
||||
}
|
||||
@@ -35,38 +36,29 @@ a:hover, a:active {
|
||||
}
|
||||
|
||||
div.header {
|
||||
background: #EEE;
|
||||
border-bottom: 1px solid #CCC;
|
||||
color: #666;
|
||||
background: #DDD;
|
||||
border-bottom: 1px solid #DDD;
|
||||
color: #444;
|
||||
}
|
||||
|
||||
div.header a {
|
||||
color: #666;
|
||||
color: #444;
|
||||
}
|
||||
|
||||
table, th, td {
|
||||
border: 1px solid #ccc;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
th {
|
||||
background: #eee;
|
||||
background: #CCC;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
background-color: rgba(120, 120, 120, 0.1);
|
||||
border: 1px solid #CCC;
|
||||
border: 1px solid #DDD;
|
||||
}
|
||||
|
||||
.img-frame {
|
||||
background-color: rgba(0, 0, 0, 0.1);
|
||||
border: 1px solid #BBB;
|
||||
}
|
||||
|
||||
figure {
|
||||
background: #EFEFEF;
|
||||
border: 1px solid #CCCCCC;
|
||||
}
|
||||
|
||||
figcaption {
|
||||
color: #777777;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
|
||||
/* specify almost no styling, just fix some image rendering */
|
||||
.img-25 {
|
||||
max-width: 25% !important;
|
||||
}
|
||||
@@ -6,3 +6,7 @@
|
||||
.img-50 {
|
||||
max-width: 50% !important;
|
||||
}
|
||||
|
||||
.img-75 {
|
||||
max-width: 75% !important;
|
||||
}
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 49 KiB |
@@ -23,7 +23,7 @@ def test_page_that_doesnt_exist(client):
|
||||
assert response.status_code == 404
|
||||
assert b'<b><tt>/ohuesthaoeusth</tt></b> does not seem to exist' in response.data
|
||||
# test the contact email config
|
||||
assert b'bss@incorporeal.org' in response.data
|
||||
assert b'admin@example.com' in response.data
|
||||
|
||||
|
||||
def test_files_outside_pages_do_not_get_served(client):
|
||||
@@ -39,7 +39,7 @@ def test_internal_server_error_serves_error_page(client):
|
||||
assert response.status_code == 500
|
||||
assert b'INTERNAL SERVER ERROR' in response.data
|
||||
# test the contact email config
|
||||
assert b'bss@incorporeal.org' in response.data
|
||||
assert b'admin@example.com' in response.data
|
||||
|
||||
|
||||
def test_oserror_is_500(client, app):
|
||||
@@ -70,28 +70,28 @@ def test_page_with_title_metadata(client):
|
||||
"""Test that a page with title metadata has its title written."""
|
||||
response = client.get('/')
|
||||
assert response.status_code == 200
|
||||
assert b'<title>Index - incorporeal.org</title>' in response.data
|
||||
assert b'<title>Index - example.com</title>' in response.data
|
||||
|
||||
|
||||
def test_page_without_title_metadata(client):
|
||||
"""Test that a page without title metadata gets the default title."""
|
||||
response = client.get('/no-title')
|
||||
assert response.status_code == 200
|
||||
assert b'<title>/no-title - incorporeal.org</title>' in response.data
|
||||
assert b'<title>/no-title - example.com</title>' in response.data
|
||||
|
||||
|
||||
def test_page_in_subdir_without_title_metadata(client):
|
||||
"""Test that the title-less page display is as expected."""
|
||||
response = client.get('/subdir//page-no-title')
|
||||
assert response.status_code == 200
|
||||
assert b'<title>/subdir/page-no-title - incorporeal.org</title>' in response.data
|
||||
assert b'<title>/subdir/page-no-title - example.com</title>' in response.data
|
||||
|
||||
|
||||
def test_page_with_card_metadata(client):
|
||||
"""Test that a page with opengraph metadata."""
|
||||
response = client.get('/more-metadata')
|
||||
assert response.status_code == 200
|
||||
assert b'<meta property="og:title" content="title for the page - incorporeal.org">' in response.data
|
||||
assert b'<meta property="og:title" content="title for the page - example.com">' in response.data
|
||||
assert b'<meta property="og:description" content="description of this page made even longer">' in response.data
|
||||
assert b'<meta property="og:image" content="http://buh.com/test.img">' in response.data
|
||||
|
||||
@@ -100,7 +100,7 @@ def test_page_with_card_title_even_when_no_metadata(client):
|
||||
"""Test that a page without metadata still has a card with the derived title."""
|
||||
response = client.get('/no-title')
|
||||
assert response.status_code == 200
|
||||
assert b'<meta property="og:title" content="/no-title - incorporeal.org">' in response.data
|
||||
assert b'<meta property="og:title" content="/no-title - example.com">' in response.data
|
||||
assert b'<meta property="og:description"' not in response.data
|
||||
assert b'<meta property="og:image"' not in response.data
|
||||
|
||||
@@ -109,7 +109,7 @@ def test_page_with_forced_empty_title_just_shows_suffix(client):
|
||||
"""Test that if a page specifies a blank Title meta tag explicitly, only the suffix is used in the title."""
|
||||
response = client.get('/forced-no-title')
|
||||
assert response.status_code == 200
|
||||
assert b'<title>incorporeal.org</title>' in response.data
|
||||
assert b'<title>example.com</title>' in response.data
|
||||
|
||||
|
||||
def test_page_with_redirect_meta_url_redirects(client):
|
||||
|
||||
@@ -20,7 +20,7 @@ def test_markdown_meta_extension_always():
|
||||
client = app.test_client()
|
||||
response = client.get('/')
|
||||
assert response.status_code == 200
|
||||
assert b'<title>Index - incorporeal.org</title>' in response.data
|
||||
assert b'<title>Index - example.com</title>' in response.data
|
||||
|
||||
|
||||
def test_custom_markdown_extensions_work():
|
||||
|
||||
@@ -9,19 +9,19 @@ from incorporealcms.pages import (generate_parent_navs, instance_resource_path_t
|
||||
def test_generate_page_navs_index(app):
|
||||
"""Test that the index page has navs to the root (itself)."""
|
||||
with app.app_context():
|
||||
assert generate_parent_navs('pages/index.md') == [('incorporeal.org', '/')]
|
||||
assert generate_parent_navs('pages/index.md') == [('example.com', '/')]
|
||||
|
||||
|
||||
def test_generate_page_navs_subdir_index(app):
|
||||
"""Test that dir pages have navs to the root and themselves."""
|
||||
with app.app_context():
|
||||
assert generate_parent_navs('pages/subdir/index.md') == [('incorporeal.org', '/'), ('subdir', '/subdir/')]
|
||||
assert generate_parent_navs('pages/subdir/index.md') == [('example.com', '/'), ('subdir', '/subdir/')]
|
||||
|
||||
|
||||
def test_generate_page_navs_subdir_real_page(app):
|
||||
"""Test that real pages have navs to the root, their parent, and themselves."""
|
||||
with app.app_context():
|
||||
assert generate_parent_navs('pages/subdir/page.md') == [('incorporeal.org', '/'), ('subdir', '/subdir/'),
|
||||
assert generate_parent_navs('pages/subdir/page.md') == [('example.com', '/'), ('subdir', '/subdir/'),
|
||||
('Page', '/subdir/page')]
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ def test_generate_page_navs_subdir_with_title_parsing_real_page(app):
|
||||
"""Test that title metadata is used in the nav text."""
|
||||
with app.app_context():
|
||||
assert generate_parent_navs('pages/subdir-with-title/page.md') == [
|
||||
('incorporeal.org', '/'),
|
||||
('example.com', '/'),
|
||||
('SUB!', '/subdir-with-title/'),
|
||||
('page', '/subdir-with-title/page')
|
||||
]
|
||||
@@ -39,7 +39,7 @@ def test_generate_page_navs_subdir_with_no_index(app):
|
||||
"""Test that breadcrumbs still generate even if a subdir doesn't have an index.md."""
|
||||
with app.app_context():
|
||||
assert generate_parent_navs('pages/no-index-dir/page.md') == [
|
||||
('incorporeal.org', '/'),
|
||||
('example.com', '/'),
|
||||
('/no-index-dir/', '/no-index-dir/'),
|
||||
('page', '/no-index-dir/page')
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user