A simple content site framework that harnesses the power of Django without the hassle.
Project description
coltrane
A simple content site framework that harnesses the power of Django without the hassle 🎵
📖 Complete documentation: https://coltrane.readthedocs.io
📦 Package located at https://pypi.org/project/coltrane-web/
⭐ Features
- Can either generate a static HTML, be used as a standalone Django site, or integrated into an existing Django site
- Write content in markdown and render it in HTML
- Use data from JSON files in templates and content
- All the power of Django templates, template tags, and filters
- Can include other Django apps for additional functionality
- Opinionated Django project setup where everything works "out of the box"
⚡ Quick start for a new static site
mkdir new-site && cd new-site
to create a new folderpoetry init --no-interaction --dependency coltrane-web:latest && poetry install
to create a new virtual environment and installcoltrane
poetry run coltrane create
to create the folder structure for a new site- Update
content/index.md
poetry run coltrane play
for a local development server- Go to http://localhost:8000 to see the updated markdown rendered into HTML
poetry run coltrane record
to output the rendered HTML files
Optional
- Enable
watchman
for less resource-intensive autoreload on Mac:brew install watchman
How to add new content
Add markdown files or sub-directories with msrkdown files to the content
directory and they will automatically have routes created that can be requested.
With this folder structure:
/content/index.md
/content/about.md
/content/articles/this-is-the-first-article.md
There will be these URLs available:
http://localhost:8000/
which serves HTML generated from the/content/index.md
filehttp://localhost:8000/about
which serves HTML generated from the/content/about.md
filehttp://localhost:8000/articles/this-is-the-first-article
which serves HTML generated from the/content/articles/this-is-the-first-article.md
file
Read all of the documentation at https://coltrane.readthedocs.io.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
coltrane-web-0.9.0.tar.gz
(15.7 kB
view hashes)
Built Distribution
Close
Hashes for coltrane_web-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed2a7c617b55e05c59ba870ae78e80fe24b5f5a4fcd562029f0e27d5caf19ecc |
|
MD5 | 78d0a9683f243182823b1405aec6a028 |
|
BLAKE2b-256 | 941b2deed852f3c716d32e251a8ca54443d9cd0c7853a9deeca8632a174d1c3f |