Compare commits
No commits in common. "b69bdb424a8e44737bba3b3e461062e4beb80749" and "9caf08a277ac047cff37dfa8206935baa991832e" have entirely different histories.
b69bdb424a
...
9caf08a277
13
CHANGELOG.md
13
CHANGELOG.md
@ -2,19 +2,6 @@
|
|||||||
|
|
||||||
Included is a summary of changes to the project, by version. Details can be found in the commit history.
|
Included is a summary of changes to the project, by version. Details can be found in the commit history.
|
||||||
|
|
||||||
## v2.0.2
|
|
||||||
|
|
||||||
### Bugfixes
|
|
||||||
|
|
||||||
* Paths for files in the `pages/` root no longer have an extra `./` in them, which made URLs look ugly and also added an
|
|
||||||
extra blank breadcrumb in the breadcrumbs.
|
|
||||||
|
|
||||||
### Improvements
|
|
||||||
|
|
||||||
* `custom-static` in the instance dir is now ignored and has no special handling --- put static files in `pages/static/`
|
|
||||||
like all the other files that get copied. This also fixes a bug where the build errored if the directory didn't exist.
|
|
||||||
* Some README typos fixed.
|
|
||||||
|
|
||||||
## v2.0.1
|
## v2.0.1
|
||||||
|
|
||||||
### Improvements
|
### Improvements
|
||||||
|
@ -14,19 +14,19 @@ Something like the following should suffice:
|
|||||||
% incorporealcms-build ./path/to/instance ./path/to/output/www/root
|
% incorporealcms-build ./path/to/instance ./path/to/output/www/root
|
||||||
```
|
```
|
||||||
|
|
||||||
This will generate the directory suitable for serving by e.g. nginx.
|
This will generate the directory suitable for serving by e.g. Nginx.
|
||||||
|
|
||||||
## Creating a Site
|
## Creating a Site
|
||||||
|
|
||||||
Put content, notably Markdown content, inside `./your-instance/pages/` and when you are ready, run the build command
|
Put content, notably Markdown content, inside `./your-instance/pages/` and when you are ready, run the build command
|
||||||
above. When you run `incorporealcms-build`, the following happens:
|
above. When you run `incorporealcms-build`, the following happens:
|
||||||
|
|
||||||
* Markdown files (ending in `.md`) are rendered via Python-Markdown as `.html` files and output to the static site
|
* Markdown files (ending in `.md`) are rendered via Python-Markdown as .html files and output to the static site
|
||||||
directory. The `.md` files are also copied there, though this behavior may be toggleable in the future.
|
directory. The `.md` files are also copied there, though this behavior may be toggleable in the future.
|
||||||
* Directory paths (e.g. a request to `/dir/`) can be served via a `/dir/index.md` file, which will generate
|
* Directory paths (e.g. a request to `/dir/`) can be served via a `/dir/index.md` file, which will generate
|
||||||
`/dir/index.html`, with the appropriate web server configuration to use `index.html` for directory listings.
|
`/dir/index.html`, with the appropriate web server configuration to use `index.html` for directory listings.
|
||||||
* Symlinks to files are retained and mirrored into the output directory, and handled per the web server's configuration,
|
* Symlinks to files are retained and mirrored into the output directory, and handled per the web server's configuration,
|
||||||
whatever it is.
|
whanever it is.
|
||||||
* All other files are copied directly, so images, text files, etc., can be referenced naturally as URLs.
|
* All other files are copied directly, so images, text files, etc., can be referenced naturally as URLs.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
@ -4,7 +4,6 @@ SPDX-FileCopyrightText: © 2025 Brian S. Stephan <bss@incorporeal.org>
|
|||||||
SPDX-License-Identifier: GPL-3.0-only
|
SPDX-License-Identifier: GPL-3.0-only
|
||||||
"""
|
"""
|
||||||
import argparse
|
import argparse
|
||||||
import logging
|
|
||||||
import os
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
import stat
|
import stat
|
||||||
@ -17,8 +16,6 @@ from incorporealcms.error_pages import generate_error_pages
|
|||||||
from incorporealcms.feed import generate_feed
|
from incorporealcms.feed import generate_feed
|
||||||
from incorporealcms.markdown import handle_markdown_file_path
|
from incorporealcms.markdown import handle_markdown_file_path
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
class StaticSiteGenerator(object):
|
class StaticSiteGenerator(object):
|
||||||
"""Generate static site output based on the instance's content."""
|
"""Generate static site output based on the instance's content."""
|
||||||
@ -56,6 +53,10 @@ class StaticSiteGenerator(object):
|
|||||||
pass
|
pass
|
||||||
self.build_in_destination(program_static_dir, static_output_dir, convert_markdown=False)
|
self.build_in_destination(program_static_dir, static_output_dir, convert_markdown=False)
|
||||||
|
|
||||||
|
# copy the instance's static dir --- should I deprecate this since it could just be stuff in pages/static/?
|
||||||
|
custom_static_dir = os.path.join(self.instance_dir, 'custom-static')
|
||||||
|
self.build_in_destination(custom_static_dir, static_output_dir, convert_markdown=False)
|
||||||
|
|
||||||
# generate the feeds
|
# generate the feeds
|
||||||
cprint("generating feeds", 'green')
|
cprint("generating feeds", 'green')
|
||||||
generate_feed('atom', self.instance_dir, tmp_output_dir)
|
generate_feed('atom', self.instance_dir, tmp_output_dir)
|
||||||
@ -88,10 +89,8 @@ class StaticSiteGenerator(object):
|
|||||||
cprint(f"copying files from '{source_dir}' to '{dest_dir}'", 'green')
|
cprint(f"copying files from '{source_dir}' to '{dest_dir}'", 'green')
|
||||||
os.chdir(source_dir)
|
os.chdir(source_dir)
|
||||||
for base_dir, subdirs, files in os.walk(source_dir):
|
for base_dir, subdirs, files in os.walk(source_dir):
|
||||||
logger.debug("starting to build against %s || %s || %s", base_dir, subdirs, files)
|
|
||||||
# remove the absolute path of the directory from the base_dir
|
# remove the absolute path of the directory from the base_dir
|
||||||
relpath = os.path.relpath(base_dir, source_dir)
|
base_dir = os.path.relpath(base_dir, source_dir)
|
||||||
base_dir = relpath if relpath != '.' else ''
|
|
||||||
# create subdirs seen here for subsequent depth
|
# create subdirs seen here for subsequent depth
|
||||||
for subdir in subdirs:
|
for subdir in subdirs:
|
||||||
self.build_subdir_in_destination(source_dir, base_dir, subdir, dest_dir)
|
self.build_subdir_in_destination(source_dir, base_dir, subdir, dest_dir)
|
||||||
@ -150,7 +149,6 @@ class StaticSiteGenerator(object):
|
|||||||
# render markdown as HTML
|
# render markdown as HTML
|
||||||
if src.endswith('.md') and convert_markdown:
|
if src.endswith('.md') and convert_markdown:
|
||||||
rendered_file = dst.removesuffix('.md') + '.html'
|
rendered_file = dst.removesuffix('.md') + '.html'
|
||||||
print(f"rendering file '{src}' -> '{rendered_file}'")
|
|
||||||
try:
|
try:
|
||||||
content = handle_markdown_file_path(src)
|
content = handle_markdown_file_path(src)
|
||||||
except UnicodeDecodeError:
|
except UnicodeDecodeError:
|
||||||
|
@ -73,21 +73,6 @@ def test_og_image():
|
|||||||
os.chdir(os.path.join(src_dir, 'pages'))
|
os.chdir(os.path.join(src_dir, 'pages'))
|
||||||
|
|
||||||
ssg.build_file_in_destination(os.path.join(HERE, 'instance', 'pages'), '', 'more-metadata.md', tmpdir, True)
|
ssg.build_file_in_destination(os.path.join(HERE, 'instance', 'pages'), '', 'more-metadata.md', tmpdir, True)
|
||||||
with open(os.path.join(tmpdir, 'more-metadata.html'), 'r') as markdown_output:
|
with open(os.path.join(tmpdir, 'more-metadata.html'), 'r') as graphviz_output:
|
||||||
data = markdown_output.read()
|
data = graphviz_output.read()
|
||||||
assert ('<meta property="og:image" content="http://example.org/test.img">') in data
|
assert ('<meta property="og:image" content="http://example.org/test.img') in data
|
||||||
|
|
||||||
|
|
||||||
def test_og_url():
|
|
||||||
"""Test that the og:url meta tag is present as expected."""
|
|
||||||
with tempfile.TemporaryDirectory() as tmpdir:
|
|
||||||
src_dir = os.path.join(HERE, 'instance')
|
|
||||||
ssg = StaticSiteGenerator(src_dir, tmpdir)
|
|
||||||
os.chdir(os.path.join(src_dir, 'pages'))
|
|
||||||
|
|
||||||
# testing a whole build run because of bugs in how I handle pathing adding a "./" in
|
|
||||||
# the generated URLs for content in the pages/ root
|
|
||||||
ssg.build_in_destination(os.path.join(HERE, 'instance', 'pages'), tmpdir, True)
|
|
||||||
with open(os.path.join(tmpdir, 'index.html'), 'r') as markdown_output:
|
|
||||||
data = markdown_output.read()
|
|
||||||
assert ('<meta property="og:url" content="http://example.org/">') in data
|
|
||||||
|
@ -18,7 +18,7 @@
|
|||||||
"level": "DEBUG",
|
"level": "DEBUG",
|
||||||
"handlers": ["console"]
|
"handlers": ["console"]
|
||||||
},
|
},
|
||||||
"incorporealcms.ssg": {
|
"incorporealcms.pages": {
|
||||||
"level": "DEBUG",
|
"level": "DEBUG",
|
||||||
"handlers": ["console"]
|
"handlers": ["console"]
|
||||||
}
|
}
|
||||||
|
31
tests/instance/config.py
Normal file
31
tests/instance/config.py
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
"""Configure the test application.
|
||||||
|
|
||||||
|
SPDX-FileCopyrightText: © 2020 Brian S. Stephan <bss@incorporeal.org>
|
||||||
|
SPDX-License-Identifier: GPL-3.0-only
|
||||||
|
"""
|
||||||
|
|
||||||
|
LOGGING = {
|
||||||
|
'version': 1,
|
||||||
|
'formatters': {
|
||||||
|
'default': {
|
||||||
|
'format': '[%(asctime)s %(levelname)-7s %(name)s] %(message)s',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
'handlers': {
|
||||||
|
'console': {
|
||||||
|
'level': 'DEBUG',
|
||||||
|
'class': 'logging.StreamHandler',
|
||||||
|
'formatter': 'default',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
'loggers': {
|
||||||
|
'incorporealcms.mdx': {
|
||||||
|
'level': 'DEBUG',
|
||||||
|
'handlers': ['console'],
|
||||||
|
},
|
||||||
|
'incorporealcms.pages': {
|
||||||
|
'level': 'DEBUG',
|
||||||
|
'handlers': ['console'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user