blogtuner 0.2.4

Dead simple static blog generator using markdown files

BlogTuner 🎵

Blog every damn day, no excuses.

BlogTuner is a ridiculously simple static blog generator that converts Markdown files to HTML with zero fuss. No complex configurations, no steep learning curves—just write and publish.

✨ Features

• Dead Simple: Convert Markdown to HTML—that's it
• Lightning Fast ⚡: Generates your entire site in milliseconds
• No Excuses 🙅: Removes all barriers to daily blogging
• RSS Ready 📡: Automatically generates an Atom feed
• Markdown Power 📝: Write in Markdown, publish as HTML
• Smart Defaults 🧠: Sensible defaults with minimal configuration
• Draft Support 📋: Mark posts as drafts with frontmatter or naming
• Date Flexibility 📅: Use frontmatter dates or file timestamps
• Smart File Organization 🗃️: Git-aware file renaming to standard format
• GitHub Pages Ready 🚀: Generate static HTML perfect for free hosting

🤔 Motivation

Some folks such as Simon Willison have convinced me to start blogging my thoughts. I wanted to keep things simple—just a dumb set of markdown files should be enough to create a super simple HTML blog.

Even with great tools like Zola, Hugo, and Pelican available, they felt too complicated for what I needed. I wanted the minimal expression of simplicity. Hence, BlogTuner was born.

The idea is to keep your markdown files in a repo, generate HTML with BlogTuner, and deploy to a service like GitHub Pages. As simple as that.

📦 Installation

The recommended way to use BlogTuner is via uvx (by the way, if you haven't heard about uv you should read about it):

uvx blogtuner build source_dir target_dir

If you prefer to install it:

uv pip install blogtuner

You can use the traditional pip workflow without uv as well.

🚀 Usage

Basic Usage

# Create a new blog directory
mkdir myblog
cd myblog

# Create your first post
echo "# Hello World" > first-post.md

# Generate your blog
uvx blogtuner build . _site

Smart File Organization

BlogTuner automatically renames your files to follow the pattern YYYY-MM-DD-slug.md.

NEW: Git-aware file renaming! 🎉

When BlogTuner normalizes your file names, it now intelligently detects if the file is part of a Git repository:

• If the file is tracked in Git, it uses git mv to rename it, preserving your Git history
• If not, it falls back to a regular file system rename

This makes BlogTuner play nicely with your Git workflow while keeping everything organized.

Frontmatter

Posts can include TOML frontmatter at the beginning of the file (if you don't include it, it will be generated during the first run):

+++
title = "My Awesome Post"
pubdate = "2024-03-28"
draft = false
slug = "custom-slug"  # Optional, defaults to filename
+++

# My Awesome Post

Content goes here...

Blog Configuration

Create a blog.toml in your source directory (it will be created on the first run if you're lazy like me):

name = "My Awesome Blog"
author = "Your Name"
base_url = "https://yourdomain.com"
base_path = "/"
lang = "en"
tz = "UTC"
footer_text = "Powered by <a href='https://github.com/alltuner/blogtuner'>Blogtuner</a>"

🛠️ Features in Detail

Post Processing

• Automatic Metadata: Extract frontmatter or use defaults
• Date Handling: Parse dates from frontmatter or use file timestamps
• Drafts: Drafts won't appear in the index or feed
• File Normalization: Files renamed to YYYY-MM-DD-slug.md with Git awareness

Site Generation

• HTML Generation: Clean, simple HTML for each post and index
• Feed Generation: Atom feed for syndication
• CSS Bundling: Simple, clean CSS included automatically
• Fast Processing: Efficient even for large numbers of posts

🧑‍💻 Contributing

Want to contribute? Awesome! But read this first:

I'm looking for simplicity, not complexity.

The best contributions to BlogTuner are ones that:

• Make it even simpler to use
• Remove complexity, not add it
• Fix bugs or improve performance
• Enhance the core functionality without bloating it

If your PR adds a ton of new features or dependencies, it's probably not a good fit.

The guiding principle is: "How can we make blogging have even fewer excuses?"

Submit your PRs and let's make blogging simpler together!

🔄 Example Workflow

1. Write posts in Markdown with optional TOML frontmatter
2. Run BlogTuner to generate HTML and Atom feed
3. Push HTML to GitHub Pages or your hosting service
4. Repeat daily (no excuses!)

👨‍💻 Author

BlogTuner is developed by David Poblador i Garcia as part of All Tuner Labs. It's created by someone who believes blogging should be simple, fast, and without barriers.

📄 License

MIT