Changelog#
0.33.0#
Bump
rich-click
dependency and slightly better command aliases support.
0.32.1#
Parse JSON5 data as UTF-8.
0.32.0#
0.31.0#
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
.
0.30.0#
Add
COLTRANE_IS_SECURE
env variable.Add
django.middleware.gzip.GZipMiddleware
,django.middleware.http.ConditionalGetMiddleware
,django.middleware.csrf.CsrfViewMiddleware
middlewares.
0.29.0#
django-unicorn
integration.Fix: Passing
INSTALLED_APPS
intoinit
now does not override the default apps.
0.28.0#
Add
DISABLE_WILDCARD_TEMPLATES
setting.Add
data
,slug
,template
, andnow
to direct HTML template for as much parity tomarkdown
content as possible.
0.27.0#
Support directory wildcards.
Add
paths
template tag.
0.26.0#
Ability to configure cache.
Allow content or data directory to be specified #48.
Fix: Handle invalid JSON data #48.
0.25.0#
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.
0.24.0#
Support Django template tags with the
mistune
markdown renderer.
0.23.1#
Include extra files when building the static site.
0.23.0#
Add
EXTRA_FILE_NAMES
setting to support serving static files likerobots.txt
.
0.22.0#
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
.
0.21.0#
Add
order_by
todirectory_contents
templatetag.Fix
TOC
outputting ‘None’ when it should beNone
.
0.20.0#
0.19.0#
Update project name to
coltrane
.
0.18.3#
Fix bug where templatetags could not be loaded when the base directory was “.”.
0.18.2#
Add
request
to the template context when building static sites.
0.18.1#
Fix bug where static site path was incorrect.
0.18.0#
Add
toc
to the template context which provides a table of contents for the markdown.
0.17.0#
Fix bug with relative URLs when generating
sitemap.xml
Automatic generation of
rss.xml
file
0.16.1#
Create
COLTRANE_SITE
setting in.env
file duringcreate
command
0.16.0#
Output an error if rendering fails during
record
commandinclude_md
template tagparent
filterServing of
/sitemap.xml
for standaloneAutomatic creation of
sitemap.xml
duringrecord
command
Breaking changes
COLTRANE_SITE
is required in .env file
0.15.1#
Include all frontmatter metadata in
directory_contents
template tag outputParse
date
frontmatter intodatetime
Parse
draft
frontmatter intoboolean
0.15.0#
directory_contents
template tagAdd
django-fastdev
for more immediate feedback when an invalid template variable is usedShow 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
0.14.0#
0.13.1#
Add
--threads
option torecord
command
0.13.0#
Multithread
record
commandBetter console output for
record
command
0.12.0#
Fix elapsed time for
record
commandMore performant collection of markdown content files
Don’t include markdown or data when collecting static files while running
record
0.11.0#
Add
--force
option tocreate
commandAutomatically refresh the browser when markdown content or data is saved
0.10.0#
Fix generating root
index.md
0.9.0#
Add support for static files
Add
watchman
supportAdd
whitenoise
for static handlingAdd
--force
option torecord
command
0.8.0#
Read
INTERNAL_IPS
from .env fileAdd
now
to template variablesInclude found template tags in built-ins
Include
humanize
template tags in built-ins
0.7.0#
Support nested directories for content and data
Update default markdown extras
0.6.0#
Add support for markdown frontmatter
Support custom templates specified in markdown frontmatter
0.5.0#
Add
build
maangement commandStore build manifest so that HTML doesn’t re-render if possible
Loosen dependencies
0.4.0#
Unit tests, coverage, and fixes for mypy
0.3.0#
Bug fixes
0.2.0#
Bug fixes
0.1.0#
Basic Django app which renders markdown files at a URL
Basic script