calico-ssg 0.3.1

Django-based static site generator

Calico - Django-based Static Site Generator

Calico is a powerful static site generator built on top of Django, combining the flexibility of Django's templating system with the simplicity and performance of static websites.

Features

• Django-powered: Leverage Django's robust templating engine and ecosystem
• Plugin System: Extensible architecture using pluggy (via djp)
• Widget-based Components: Modular, reusable UI components
• Multiple Themes: Built-in PicoCSS theme with support for custom themes
• Blog System: Full-featured blog plugin with categories, tags, and RSS
• Collections: Organize and display grouped content
• Development Server: Live-reload development environment
• Search Support: Built-in search functionality with lunr.js

Installation

pip install calico-ssg

Or install from source:

git clone https://codeberg.org/emmaDelescolle/calico.git
cd calico
pip install -e .

Quick Start

1. Initialize a new site:

calico init

2. Start the development server:

calico run

3. Build your static site:

calico build

Creating Content

Content in Calico is written in Markdown with YAML frontmatter:

---
title: My First Post
date: 2024-01-15
tags: [introduction, calico]
---

# Welcome to My Site

This is my first post using Calico!

Plugin Development

Create custom plugins to extend Calico's functionality:

calico start_plugin my_plugin

Plugins can hook into various aspects of the build process:

• Add template tags and filters
• Register themes and templates
• Include CSS and JavaScript
• Define custom content collections
• Add context processors

Project Structure

my-site/
\x00\x00 content/          # Markdown content files
\x00\x00 static/           # Static assets (images, css, js)
\x00\x00 templates/        # Custom templates
\x00\x00 plugins/          # Local plugins
\x00\x00 config.yml        # Site configuration

Documentation

For detailed documentation, visit the Calico repository.

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests to the Calico repository.

License

Calico is distributed under the MIT License.

Repository

• Source Code: https://codeberg.org/emmaDelescolle/calico
• Issue Tracker: https://codeberg.org/emmaDelescolle/calico/issues