Skip to content

Commit 1f5c000

Browse files
mine3krishmine3krish
authored
Merge pull request #7 from mine3krish/fix-readme
Fix readme
2 parents 7c65991 + 2a6dd4a commit 1f5c000

File tree

10 files changed

+1079
-197
lines changed

10 files changed

+1079
-197
lines changed

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ npm install
3333
npm run build
3434

3535
# Serve locally
36-
npm run serve
36+
npm run dev
3737
```
3838

3939
### 5. Commit and Push

‎README.md‎

Lines changed: 94 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,83 @@
1-
# Zeno — Blazing fast blogs for everyone
1+
<a id="top"></a>
2+
<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>
23

3-
Zeno is a lightweight, plugin-first Markdown → Blog framework built with JavaScript. It's designed to be simple, hackable, and extendable.
4+
## 📑 Table of Contents
45

5-
---
6+
- [✨ Features](#-features)
7+
- [🎯 MVP Goal](#-mvp-goal)
8+
- [🚀 Quick Start](#-quick-start)
9+
- [📂 Project Structure](#-project-structure)
10+
- [🖼 Example](#-example)
11+
- [⚙️ Configuration](#️-configuration)
12+
- [🛣 Roadmap](#-roadmap)
13+
- [🤝 Contributing](#-contributing)
14+
- [⚡ Plugin Hooks (Developers)](#-plugin-hooks-developers)
15+
- [📜 License](#-license)
616

7-
## 🚀 Quick Start
17+
<hr>
818

9-
```bash
10-
# Create a new blog
11-
npx zeno init mysite
12-
cd mysite
19+
### ✨ Features
1320

14-
# Build the blog
15-
zeno build
21+
- ✅ Write posts in Markdown
22+
- ✅ Zero Config – start instantly
23+
- ✅ 🎨 Custom Themes (minimal, modern, dark, etc.)
24+
- ✅ Custom plugins support
25+
- ✅ 📦 Static Export for deployment (Netlify, Vercel, GitHub Pages)
26+
- ✅ 🌍 Beginner-friendly open source project
1627

17-
# Start the development server
18-
zeno serve 3000
19-
```
28+
<hr>
2029

21-
---
22-
23-
## ✨ Core MVP Features
24-
25-
* **Markdown to HTML** — Write posts in plain `.md` files with frontmatter.
26-
* **Themes** — Simple folder-based themes (`post.html`, `index.html`, `style.css`).
27-
* **Plugins** — Extend with hooks: `onMarkdownParse`, `onRenderHTML`, `onPostBuild`.
28-
* **CLI** — `init`, `build`, `serve` commands.
29-
* **Config file** — `zeno.config.json` for theme + plugins.
30-
* **Tags support** — Add tags in post frontmatter to show on homepage and post pages.
30+
### 🎯 MVP Goal
31+
Deliver a fast, hackable blogging framework where developers can:
32+
- 📝 Write in Markdown
33+
- 🎨 Apply themes
34+
- ⚡ Extend with plugins
35+
- 🏷️ Add tags to posts
36+
- 🚀 Publish with one command
3137

32-
---
38+
<hr>
3339

34-
## 🛠 Example Workflow
40+
### 🚀 Quick start
41+
🔧 Requirements
42+
- Node.js v18+
43+
- npm/yarn/pnpm
3544

45+
⚡ Install & Run
3646
```bash
37-
# create new blog
47+
# Create a new blog
3848
npx zeno-blog init mysite
3949
cd mysite
4050

41-
# build blog
42-
zeno build
51+
# Build the blog
52+
npx zeno-blog build
4353

44-
# start local dev server
45-
zeno serve 3000
54+
# Start the development server
55+
npx zeno-blog serve 3000
4656
```
57+
Open 👉 http://localhost:3000
58+
<hr>
4759

48-
---
60+
### 📂 Project Structure
4961

50-
## 🔌 Example Plugin
51-
52-
```js
53-
// plugins/popup.js
54-
export default function popupPlugin(options) {
55-
return {
56-
name: 'popup-plugin',
57-
onRenderHTML(html) {
58-
const script = `
59-
<script>
60-
window.addEventListener('load', () => {
61-
alert('${options.message || "Hello from plugin!"}');
62-
});
63-
</script>
64-
`;
65-
return html.replace('</body>', script + '</body>');
66-
}
67-
};
68-
}
6962
```
70-
71-
Configure in `zeno.config.json`:
72-
73-
```json
74-
{
75-
"title": "My Blog",
76-
"theme": "default",
77-
"plugins": [
78-
{ "name": "popup", "options": { "message": "Welcome to my blog!" } }
79-
]
80-
}
63+
zeno/
64+
├── bin/
65+
│ └── zeno.js
66+
├── src/
67+
│ ├── builder.js
68+
│ ├── cli.js
69+
│ ├── config.js
70+
│ └── server.js
71+
├── plugins/
72+
│ └── popup.js
73+
├── themes/
74+
│ └── default/
75+
└── posts/
76+
└── first-post.md
8177
```
78+
<hr>
8279

83-
---
84-
85-
## 📝 Markdown Post Example
80+
### 🖼 Example
8681

8782
```md
8883
---
@@ -94,10 +89,12 @@ tags: "first post, blog"
9489
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.
9590
```
9691

97-
---
92+
👉 Preview (Clazzy theme):
9893

99-
## 🏗 Theme Structure
94+
<p align="center"> <img src="images/blog.png" width="600" alt="Sample Blog Screenshot"/> </p>
95+
<hr>
10096

97+
### ⚙️ Configuration
10198
```
10299
themes/default/
103100
├── components/
@@ -109,55 +106,48 @@ themes/default/
109106
```
110107

111108
* `components/` — Reusable components for your pages.
109+
* `components/posts.html` - Individual post template.
112110
* `index.html` — Home page template.
113111
* `post.html` — Individual post template.
114112
* `style.css` — Theme styles.
113+
<hr>
115114

116-
---
115+
### 🛣 Roadmap
116+
- [ ] 🌗 Search Feature
117+
- [ ] 🏷️ Tag archive pages
118+
- [ ] 🔍 Filtering posts by tags
119+
- [ ] 🎨✨ Advanced theme customization
117120

118-
## ⚡ Plugin Hooks
121+
<hr>
119122

120-
* `onMarkdownParse(markdown, frontmatter)` — Modify Markdown before rendering.
121-
* `onRenderHTML(html, frontmatter)` — Modify HTML after rendering.
122-
* `onPostBuild(distDir)` — Hook after the blog is built.
123+
### 🤝 Contributing
124+
💡 Contributions are welcome!
125+
- 1. Fork the repo
126+
- 2. Create a feature branch (git checkout -b feature/my-feature)
127+
- 3. Commit and push your changes
128+
- 4. Submit a pull request
123129

124-
---
130+
[![Contributing](https://img.shields.io/badge/Contributing-Guidelines-blue)](CONTRIBUTING.md)
125131

126-
## 💡 Features in Progress
132+
<hr>
127133

128-
* Tag archive pages.
129-
* Filtering posts by tags.
130-
* Advanced theme customization.
134+
### ⚡ Plugin Hooks (Developers)
135+
Zeno provides plugin hooks so developers can extend functionality:
136+
- `onMarkdownParse(markdown, frontmatter)` — Modify Markdown before rendering.
137+
- `onRenderHTML(html, frontmatter)` — Modify HTML after rendering.
138+
- `onPostBuild(distDir)` — Hook after the blog is built.
131139

132-
---
140+
<hr>
133141

134-
## 📂 Project Structure
142+
### 📜 License
143+
Zeno is licensed under the MIT License - see [LICENSE](LICENSE)
135144

136-
```
137-
zeno/
138-
├── bin/
139-
│ └── zeno.js
140-
├── src/
141-
│ ├── builder.js
142-
│ ├── cli.js
143-
│ ├── config.js
144-
│ └── server.js
145-
├── plugins/
146-
│ └── popup.js
147-
├── themes/
148-
│ └── default/
149-
└── posts/
150-
└── first-post.md
151-
```
145+
[![Star History Chart](https://api.star-history.com/svg?repos=mine3krish/zeno&type=Date)](https://www.star-history.com/#mine3krish/zeno&Date)
152146

153-
---
154-
155-
## ✅ MVP Goal
156-
157-
Deliver a fast, hackable blogging framework where developers can:
147+
## 🔥 Start blogging the easy way with Zeno today!
148+
<p align="center">
149+
<a href="#top">
150+
<img src="https://img.shields.io/badge/⬆️-Back_to_Top-blue?style=for-the-badge" alt="Back to Top"/>
151+
</a>
152+
</p>
158153

159-
* Write in Markdown
160-
* Apply themes
161-
* Extend with plugins
162-
* Add tags to posts
163-
* Publish with one command

0 commit comments

Comments
 (0)