Zeno

<a id="top"></a>

<p align="center"> <img src="images/logo.png" alt="Zeno Logo" width="600"/> </p> <p align="center"> <b>Turn your Markdown files into a full-featured blog with zero hassle 🚀</b> </p> <p align="center"> <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a> <img src="https://img.shields.io/badge/Node-%3E=18-green"> <img src="https://img.shields.io/badge/PRs-Welcome-brightgreen"> <img src="https://img.shields.io/github/stars/mine3krish/zeno?style=social"> </p>

📑 Table of Contents

• ✨ Features
• 🎯 MVP Goal
• 🚀 Quick Start
• 📂 Project Structure
• 🖼 Example
• ⚙️ Configuration
• 🛣 Roadmap
• 🤝 Contributing
• ⚡ Plugin Hooks (Developers)
• 📜 License

<hr>

✨ Features

• ✅ Write posts in Markdown
• ✅ Zero Config – start instantly
• ✅ 🎨 Custom Themes (minimal, modern, dark, etc.)
• ✅ Custom plugins support
• ✅ 📦 Static Export for deployment (Netlify, Vercel, GitHub Pages)
• ✅ 🌍 Beginner-friendly open source project

<hr>

🎯 MVP Goal

Deliver a fast, hackable blogging framework where developers can:

• 📝 Write in Markdown
• 🎨 Apply themes
• ⚡ Extend with plugins
• 🏷️ Add tags to posts
• 🚀 Publish with one command

<hr>

🚀 Quick start

🔧 Requirements

• Node.js v18+
• npm/yarn/pnpm

⚡ Install & Run

# Create a new blog
npx zeno-blog init mysite
cd mysite

# Build the blog
npx zeno-blog build

# Start the development server
npx zeno-blog serve 3000

Open 👉 http://localhost:3000

<hr>

📂 Project Structure

zeno/
├── bin/
│   └── zeno.js
├── src/
│   ├── builder.js
│   ├── cli.js
│   ├── config.js
│   └── server.js
├── plugins/
│   └── popup.js
├── themes/
│   └── default/
└── posts/
    └── first-post.md

<hr>

🖼 Example

---
title: "What is Zeno?"
date: "2025-09-19"
tags: "first post, blog"
---

Zeno is a plugin-first Markdown blog framework built in JavaScript. It allows you to write in Markdown, apply themes, extend with plugins, and publish your blog with one command.

👉 Preview (Clazzy theme):

<p align="center"> <img src="images/blog.png" width="600" alt="Sample Blog Screenshot"/> </p> <hr>

⚙️ Configuration

themes/default/
├── components/
│   ├── navbar.html
│   └── posts.html
├── index.html
├── post.html
└── style.css

• components/ — Reusable components for your pages.
• components/posts.html - Individual post template.
• index.html — Home page template.
• post.html — Individual post template.
• style.css — Theme styles.

<hr>

🛣 Roadmap

• [ ] 🌗 Search Feature
• [ ] 🏷️ Tag archive pages
• [ ] 🔍 Filtering posts by tags
• [ ] 🎨✨ Advanced theme customization

<hr>

🤝 Contributing

💡 Contributions are welcome!

• 1. Fork the repo
• 2. Create a feature branch (git checkout -b feature/my-feature)
• 3. Commit and push your changes
• 4. Submit a pull request

<hr>

⚡ Plugin Hooks (Developers)

Zeno provides plugin hooks so developers can extend functionality:

• onMarkdownParse(markdown, frontmatter) — Modify Markdown before rendering.
• onRenderHTML(html, frontmatter) — Modify HTML after rendering.
• onPostBuild(distDir) — Hook after the blog is built.

<hr>

📜 License

Zeno is licensed under the MIT License - see LICENSE

🔥 Start blogging the easy way with Zeno today!

<p align="center"> <a href="#top"> <img src="https://img.shields.io/badge/⬆️-Back_to_Top-blue?style=for-the-badge" alt="Back to Top"/> </a> </p>