- Automatically enable
dj-angles
if the library is installed. - Experimental support for multiple domains.
Breaking changes
- Drop support for Python 3.8.
- Remove loading deprecated
data.json
file.
- Handle string, date, epoch in
publish_date
and convert them to timezone-aware datetime.
- Prevent missing
compress
templatetag from raising an error when calling thecompress
management command.
- Set
COMPRESS_OFFLINE=True
when running thecompress
management command.
- Add all environment variables to
settings.ENV
, not just the variables from.env
.
- Update default
Dockerfile
to fix some deployment problems.
- Include variables from
.env
file insettings.ENV
. - Rewrite all docs to remove any perceived dependency on
poetry
. - Create nested folder structure for new sites.
- Add
coltrane
context template variable to expose thecoltrane
settings. - Add support for
django-compressor
. - Add support for redirects.
- Bump
rich-click
dependency and slightly better command aliases support.
- Parse JSON5 data as UTF-8.
- Create example
Dockerfile
andgunicorn.conf.py
files for easier deployments ofcoltrane
apps. - Add the ability to use JSON5 for data files.
Breaking changes
- Remove loading
data.json
. All data should be in JSON files in thedata
directory. - The default markdown renderer is now
mistune
instead ofmarkdown2
. The next version ofcoltrane
will remove the option to usemarkdown2
.
- Add
COLTRANE_IS_SECURE
env variable. - Add
django.middleware.gzip.GZipMiddleware
,django.middleware.http.ConditionalGetMiddleware
,django.middleware.csrf.CsrfViewMiddleware
middlewares.
django-unicorn
integration.- Fix: Passing
INSTALLED_APPS
intoinit
now does not override the default apps.
- Add
DISABLE_WILDCARD_TEMPLATES
setting. - Add
data
,slug
,template
, andnow
to direct HTML template for as much parity tomarkdown
content as possible.
- Support directory wildcards.
- Add
paths
template tag.
- Ability to configure cache.
- Allow content or data directory to be specified #48.
- Fix: Handle invalid JSON data #48.
- If a markdown file with a slug cannot be found, look for a template with the same slug. Special case for
*.html
which can be a fall-back option to render for any slug. - Add
raise_404
template tag. - Add
last_path
template tag.
- Support Django template tags with the
mistune
markdown renderer.
- Include extra files when building the static site.
- Add
EXTRA_FILE_NAMES
setting to support serving static files likerobots.txt
.
- Add support for rendering markdown with
mistune
. See MARKDOWN_RENDERED for how to enable.mistune
will be the default renderer after 0.22.0 because it is 1) faster rendering markdown thanmarkdown2
, 2) enables new functionality likeabbr
, 3) fixed a bug in the generation of the tables of contents HTML, and 4) has a plugin architecture to add new features. - Improve table of contents rendering for
mistune
.
- Add
order_by
todirectory_contents
templatetag. - Fix
TOC
outputting 'None' when it should beNone
.
- Add
to_html
template tag. #37 by Tobi-De - Breaking change: change
date
topublish_date
in metadata. #39 by Tobi-De - Breaking change: change
SITE
setting toSITE_URL
. - Automatically add
verbatim
templatetag around code fences.
- Update project name to
coltrane
.
- Fix bug where templatetags could not be loaded when the base directory was ".".
- Add
request
to the template context when building static sites.
- Fix bug where static site path was incorrect.
- Add
toc
to the template context which provides a table of contents for the markdown.
- Fix bug with relative URLs when generating
sitemap.xml
- Automatic generation of
rss.xml
file
- Create
COLTRANE_SITE
setting in.env
file duringcreate
command
- Output an error if rendering fails during
record
command include_md
template tagparent
filter- Serving of
/sitemap.xml
for standalone - Automatic creation of
sitemap.xml
duringrecord
command
Breaking changes
COLTRANE_SITE
is required in .env file
- Include all frontmatter metadata in
directory_contents
template tag output - Parse
date
frontmatter intodatetime
- Parse
draft
frontmatter intoboolean
directory_contents
template tag- Add
django-fastdev
for more immediate feedback when an invalid template variable is used - Show error message if a markdown file cannot be output to HTML
- Fix bug where
index.md
files in a sub-directory were not output correctly
- Add
--threads
option torecord
command
- Multithread
record
command - Better console output for
record
command
- Fix elapsed time for
record
command - More performant collection of markdown content files
- Don't include markdown or data when collecting static files while running
record
- Add
--force
option tocreate
command - Automatically refresh the browser when markdown content or data is saved
- Fix generating root
index.md
- Add support for static files
- Add
watchman
support - Add
whitenoise
for static handling - Add
--force
option torecord
command
- Read
INTERNAL_IPS
from .env file - Add
now
to template variables - Include found template tags in built-ins
- Include
humanize
template tags in built-ins
- Support nested directories for content and data
- Update default markdown extras
- Add support for markdown frontmatter
- Support custom templates specified in markdown frontmatter
- Add
build
maangement command - Store build manifest so that HTML doesn't re-render if possible
- Loosen dependencies
- Unit tests, coverage, and fixes for mypy
- Bug fixes
- Bug fixes
- Basic Django app which renders markdown files at a URL
- Basic script