chalknotes 0.0.24 → 0.0.26

package/README.md

@@ -0,0 +1,231 @@
+# ✏️ ChalkNotes
+
+**Turn your Notion database into a blog with zero config. Works with Next.js Page Router and App Router.**
+
+---
+
+## 🚀 Features
+
+- 📄 Fetch blog posts from Notion
+- 🪄 Auto-generate routes for App Router or Page Router
+- ⚙️ Helpers for `getStaticProps` / `getStaticPaths`
+- 🎨 Clean, responsive themes (light & dark mode)
+- 🔧 Interactive configuration setup
+- 📁 Customizable route paths
+- 🧠 Minimal setup – just run `chalknotes`
+
+---
+
+## 📦 Installation
+
+```bash
+pnpm add chalknotes
+# or
+npm install chalknotes
+```
+
+---
+
+## 🧙‍♂️ Quick Start
+
+1. **Set up environment variables**
+   ```bash
+   # Create .env file
+   NOTION_TOKEN=secret_...
+   NOTION_DATABASE_ID=xxxxxxxxxxxxxxxxxxxxxx
+   ```
+
+2. **Run the CLI**
+   ```bash
+   npx chalknotes
+   ```
+
+3. **That's it!** ✅
+   - Automatically detects if you're using **App Router** or **Page Router**
+   - Creates `blog.config.js` with default configuration (if needed)
+   - Generates blog routes with clean, responsive templates
+   - Supports light and dark themes
+
+---
+
+## 🔧 Configuration
+
+The CLI creates a `blog.config.js` file in your project root. Customize it to match your needs:
+
+```javascript
+module.exports = {
+  // Notion Configuration
+  notionToken: process.env.NOTION_TOKEN,
+  notionDatabaseId: process.env.NOTION_DATABASE_ID,
+  
+  // Blog Configuration
+  routeBasePath: '/blog',  // Default: '/blog'
+  theme: 'default',        // Options: 'default' (light) or 'dark'
+  plugins: [],
+};
+```
+
+### Configuration Options
+
+- **`routeBasePath`**: Customize your blog route (e.g., `/posts`, `/articles`)
+- **`theme`**: Choose between `'default'` (light mode) or `'dark'` (dark mode)
+- **`plugins`**: Array for future plugin support
+
+---
+
+## 🎨 Themes
+
+### Default Theme (Light Mode)
+- Clean white cards with subtle shadows
+- Light gray background
+- Dark text for optimal readability
+- Responsive design with Tailwind CSS
+
+### Dark Theme
+- Dark background with gray cards
+- White text with proper contrast
+- Inverted typography for dark mode
+- Same responsive layout
+
+---
+
+## 📚 Usage in Next.js
+
+### Page Router
+
+Creates:
+
+```js
+// pages/blog/[slug].js (or custom route)
+import { getStaticPropsForPost, getStaticPathsForPosts } from 'chalknotes';
+
+export const getStaticProps = getStaticPropsForPost;
+export const getStaticPaths = getStaticPathsForPosts;
+
+export default function BlogPost({ post }) {
+  return (
+    <div className="min-h-screen bg-gray-50">
+      <main className="max-w-4xl mx-auto px-4 sm:px-6 lg:px-8 py-12">
+        <article className="bg-white rounded-lg shadow-sm border border-gray-200 p-8">
+          <h1 className="text-4xl font-bold text-gray-900 mb-6 leading-tight">
+            {post.title}
+          </h1>
+          <div 
+            className="prose prose-lg max-w-none text-gray-700 leading-relaxed"
+            dangerouslySetInnerHTML={{ __html: post.content }} 
+          />
+        </article>
+      </main>
+    </div>
+  );
+}
+```
+
+---
+
+### App Router
+
+Creates:
+
+```jsx
+// app/blog/[slug]/page.jsx (or custom route)
+import { getPostBySlug } from 'chalknotes';
+
+export default async function BlogPost({ params }) {
+  const post = await getPostBySlug(params.slug);
+
+  return (
+    <div className="min-h-screen bg-gray-50">
+      <main className="max-w-4xl mx-auto px-4 sm:px-6 lg:px-8 py-12">
+        <article className="bg-white rounded-lg shadow-sm border border-gray-200 p-8">
+          <h1 className="text-4xl font-bold text-gray-900 mb-6 leading-tight">
+            {post.title}
+          </h1>
+          <div 
+            className="prose prose-lg max-w-none text-gray-700 leading-relaxed"
+            dangerouslySetInnerHTML={{ __html: post.content }} 
+          />
+        </article>
+      </main>
+    </div>
+  );
+}
+```
+
+---
+
+## 🧩 API
+
+### `getPostBySlug(slug: string)`
+Fetches a post and renders Notion blocks as HTML.
+
+```js
+const post = await getPostBySlug('my-post-title');
+```
+
+---
+
+### `getAllPosts()`
+Returns all published posts with metadata:
+
+```js
+[
+  {
+    title: "My First Post",
+    slug: "my-first-post",
+    notionPageId: "xxxxxxxx"
+  },
+  ...
+]
+```
+
+---
+
+### `getStaticPropsForPost()`
+For use with `getStaticProps` in Page Router.
+
+---
+
+### `getStaticPathsForPosts()`
+For use with `getStaticPaths` in Page Router.
+
+---
+
+## 🎨 Styling
+
+The generated templates use Tailwind CSS with:
+- Clean, minimal design
+- Responsive layout
+- Typography optimized for readability
+- Proper spacing and hierarchy
+- Light and dark mode support
+
+Make sure you have Tailwind CSS installed in your project:
+
+```bash
+npm install -D tailwindcss @tailwindcss/typography
+```
+
+---
+
+## 📅 Roadmap
+
+- [ ] Plugin system for custom components
+- [ ] More Notion block support (images, lists, code blocks)
+- [ ] RSS feed support
+- [ ] MDX or Markdown output option
+- [ ] Custom theme templates
+- [ ] Search functionality
+- [ ] Categories and tags support
+
+---
+
+## 💡 Inspiration
+
+Built to scratch an itch while exploring the simplicity of tools like [feather.so](https://feather.so/) and [Notion Blog](https://github.com/ijjk/notion-blog).
+
+---
+
+## 🧑‍💻 Author
+
+[NepTune](https://github.com/yourhandle) • MIT License

package/bin/cli.js

@@ -1,20 +1,95 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const fs = require("fs");
 const path = require("path");
+const dotenv = require("dotenv");
+const readline = require("readline");
+dotenv.config();
 
-console.log("Initializing ChalkNotes...");
+console.log("🚀 Initializing ChalkNotes...");
+
+// Check environment variables
+if (!process.env.NOTION_TOKEN) {
+    console.error("❌ NOTION_TOKEN is not set in .env file");
+    console.log("💡 Please create a .env file with your NOTION_TOKEN");
+    process.exit(1);
+}
+
+if (!process.env.NOTION_DATABASE_ID) {
+    console.error("❌ NOTION_DATABASE_ID is not set in .env file");
+    console.log("💡 Please create a .env file with your NOTION_DATABASE_ID");
+    process.exit(1);
+}
+
+console.log("✅ Environment variables are set");
 
 const configPath = path.join(process.cwd(), 'blog.config.js');
-const pageRouter = path.join(process.cwd(), '/pages')
-const appRouter = path.join(process.cwd(), '/app')
 
+// Check if blog.config.js exists
+if (!fs.existsSync(configPath)) {
+    console.log("\n❌ blog.config.js not found");
+    console.log("This file is required to configure your blog settings.");
+    
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout
+    });
+    
+    rl.question("Would you like to create a default blog.config.js? (y/n): ", (answer) => {
+        if (answer.toLowerCase() === 'y' || answer.toLowerCase() === 'yes') {
+            console.log("📝 Creating blog.config.js with default configuration...");
+            
+            const configTemplate = `module.exports = {
+  notionToken: process.env.NOTION_TOKEN,
+  notionDatabaseId: process.env.NOTION_DATABASE_ID,
+  routeBasePath: '/blog',
+  theme: 'default',
+  plugins: [],
+};`.trim();
+            
+            fs.writeFileSync(configPath, configTemplate);
+            console.log("✅ Created blog.config.js with default configuration");
+            console.log("\n💡 Now you can re-run 'npx chalknotes' to scaffold your blog pages!");
+        } else {
+            console.log("❌ Please create a blog.config.js file and try again.");
+        }
+        rl.close();
+    });
+    return;
+}
 
-if (fs.existsSync(pageRouter)) {
-    console.log("✅ Page router found");
-    const slugDir = path.join(pageRouter, "blog", "[slug].js")
-    const dirPath = path.dirname(slugDir);
+// Load configuration
+let config;
+try {
+    config = require(configPath);
+} catch (error) {
+    console.error("❌ Error loading blog.config.js:", error.message);
+    process.exit(1);
+}
 
-    const pageRouterTemplate = `
+// Set defaults for missing config values
+config.routeBasePath = config.routeBasePath || '/blog';
+config.theme = config.theme || 'default';
+
+console.log("✅ Configuration loaded successfully");
+console.log(`📁 Route base path: ${config.routeBasePath}`);
+console.log(`🎨 Theme: ${config.theme}`);
+
+// Ask to proceed with scaffolding
+console.log("\n🔨 Ready to scaffold your blog page?");
+console.log("This will create a clean, responsive blog template using Tailwind CSS.");
+console.log("Press Enter to continue or Ctrl+C to cancel...");
+
+// Create blog page templates based on theme and route
+const pageRouter = path.join(process.cwd(), '/pages')
+const appRouter = path.join(process.cwd(), '/app')
+
+// Generate templates based on theme
+function getTemplates(theme, routeBasePath) {
+    const routePath = routeBasePath.replace(/^\//, ''); // Remove leading slash
+    
+    if (theme === 'dark') {
+        return {
+            pageRouter: `
 import { getStaticPropsForPost, getStaticPathsForPosts } from 'chalknotes';
 
 export const getStaticProps = getStaticPropsForPost;
@@ -22,53 +97,129 @@ export const getStaticPaths = getStaticPathsForPosts;
 
 export default function BlogPost({ post }) {
   return (
-    <article>
-      <h1>{post.title}</h1>
-      <div dangerouslySetInnerHTML={{ __html: post.content }} />
-    </article>
+    <div className="min-h-screen bg-gray-900">
+      <main className="max-w-4xl mx-auto px-4 sm:px-6 lg:px-8 py-12">
+        <article className="bg-gray-800 rounded-lg shadow-lg border border-gray-700 p-8">
+          <h1 className="text-4xl font-bold text-white mb-6 leading-tight">
+            {post.title}
+          </h1>
+          <div 
+            className="prose prose-lg prose-invert max-w-none text-gray-300 leading-relaxed"
+            dangerouslySetInnerHTML={{ __html: post.content }} 
+          />
+        </article>
+      </main>
+    </div>
   );
-}
-`.trim();
+}`.trim(),
+            appRouter: `
+import { getPostBySlug } from 'chalknotes';
 
-    fs.mkdirSync(dirPath, { recursive: true });
-    fs.writeFileSync(slugDir, pageRouterTemplate)
-} else if (fs.existsSync(appRouter)) {
-    console.log("✅ App router found");
-    const slugDir = path.join(appRouter, 'blog', "[slug]", "page.jsx")
-    const dirPath = path.dirname(slugDir);
+export default async function BlogPost({ params }) {
+  const post = await getPostBySlug(params.slug);
 
-    const appRouterTemplate = `
+  return (
+    <div className="min-h-screen bg-gray-900">
+      <main className="max-w-4xl mx-auto px-4 sm:px-6 lg:px-8 py-12">
+        <article className="bg-gray-800 rounded-lg shadow-lg border border-gray-700 p-8">
+          <h1 className="text-4xl font-bold text-white mb-6 leading-tight">
+            {post.title}
+          </h1>
+          <div 
+            className="prose prose-lg prose-invert max-w-none text-gray-300 leading-relaxed"
+            dangerouslySetInnerHTML={{ __html: post.content }} 
+          />
+        </article>
+      </main>
+    </div>
+  );
+}`.trim()
+        };
+    } else {
+        // Default theme (light mode)
+        return {
+            pageRouter: `
+import { getStaticPropsForPost, getStaticPathsForPosts } from 'chalknotes';
+
+export const getStaticProps = getStaticPropsForPost;
+export const getStaticPaths = getStaticPathsForPosts;
+
+export default function BlogPost({ post }) {
+  return (
+    <div className="min-h-screen bg-gray-50">
+      <main className="max-w-4xl mx-auto px-4 sm:px-6 lg:px-8 py-12">
+        <article className="bg-white rounded-lg shadow-sm border border-gray-200 p-8">
+          <h1 className="text-4xl font-bold text-gray-900 mb-6 leading-tight">
+            {post.title}
+          </h1>
+          <div 
+            className="prose prose-lg max-w-none text-gray-700 leading-relaxed"
+            dangerouslySetInnerHTML={{ __html: post.content }} 
+          />
+        </article>
+      </main>
+    </div>
+  );
+}`.trim(),
+            appRouter: `
 import { getPostBySlug } from 'chalknotes';
 
 export default async function BlogPost({ params }) {
   const post = await getPostBySlug(params.slug);
 
   return (
-    <article>
-      <h1>{post.title}</h1>
-      <div dangerouslySetInnerHTML={{ __html: post.content }} />
-    </article>
+    <div className="min-h-screen bg-gray-50">
+      <main className="max-w-4xl mx-auto px-4 sm:px-6 lg:px-8 py-12">
+        <article className="bg-white rounded-lg shadow-sm border border-gray-200 p-8">
+          <h1 className="text-4xl font-bold text-gray-900 mb-6 leading-tight">
+            {post.title}
+          </h1>
+          <div 
+            className="prose prose-lg max-w-none text-gray-700 leading-relaxed"
+            dangerouslySetInnerHTML={{ __html: post.content }} 
+          />
+        </article>
+      </main>
+    </div>
   );
+}`.trim()
+        };
+    }
 }
-`.trim();
 
+// Create blog page templates
+if (fs.existsSync(pageRouter)) {
+    console.log("✅ Page router found");
+    const routePath = config.routeBasePath.replace(/^\//, ''); // Remove leading slash
+    const slugDir = path.join(pageRouter, routePath, "[slug].js")
+    const dirPath = path.dirname(slugDir);
+
+    const templates = getTemplates(config.theme, config.routeBasePath);
+    
+    fs.mkdirSync(dirPath, { recursive: true });
+    fs.writeFileSync(slugDir, templates.pageRouter);
+    console.log(`✅ Created pages/${routePath}/[slug].js`);
+    
+} else if (fs.existsSync(appRouter)) {
+    console.log("✅ App router found");
+    const routePath = config.routeBasePath.replace(/^\//, ''); // Remove leading slash
+    const slugDir = path.join(appRouter, routePath, "[slug]", "page.jsx")
+    const dirPath = path.dirname(slugDir);
+
+    const templates = getTemplates(config.theme, config.routeBasePath);
+    
     fs.mkdirSync(dirPath, { recursive: true });
-    fs.writeFileSync(slugDir, appRouterTemplate)
+    fs.writeFileSync(slugDir, templates.appRouter);
+    console.log(`✅ Created app/${routePath}/[slug]/page.jsx`);
+    
 } else {
-    console.log("❌ Page router and app router not found");
+    console.log("❌ Neither pages/ nor app/ directory found");
+    console.log("💡 Please make sure you're running this in a Next.js project");
+    process.exit(1);
 }
 
-// if (!fs.existsSync(configPath)) {
-//     const configTemplate = `
-// module.exports = {
-//   notionDatabaseId: '',
-//   notionToken: process.env.NOTION_TOKEN,
-//   routeBasePath: '/blog',
-//   plugins: [],
-// };
-// `;
-//     fs.writeFileSync(configPath, configTemplate.trim());
-//     console.log("✅ Created blog.config.js");
-// } else {
-//     console.log("⚠️  blog.config.js already exists");
-// }
+console.log("\n🎉 Blog page scaffolded successfully!");
+console.log(`\n📝 Next steps:`);
+console.log("1. Add Tailwind CSS to your project if not already installed");
+console.log("2. Start your development server");
+console.log(`3. Visit ${config.routeBasePath}/[your-post-slug] to see your blog`);

package/blog.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  notionToken: process.env.NOTION_TOKEN,
+  notionDatabaseId: process.env.NOTION_DATABASE_ID,
+  routeBasePath: '/blog',
+  theme: 'default',
+  plugins: [],
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chalknotes",
-  "version": "0.0.24",
+  "version": "0.0.26",
   "description": "A tool that simplifies blogs.",
   "main": "src/index.js",
   "bin": {

package/src/lib/getPostBySlug.js

@@ -12,6 +12,9 @@ const getPostBySlug = async (slug) => {
                 }
             }
         })
+        if (response.results.length === 0) {
+            throw new Error("No posts found");
+        }
 
         for (const page of response.results) {
             const titleProperty = page.properties["Name"];
@@ -27,22 +30,21 @@ const getPostBySlug = async (slug) => {
                     switch (block.type) {
                         case "paragraph":
                             const textHTML = block.paragraph.rich_text.map(text => text.plain_text).join("");
-                            content += `<p>${textHTML}</p>`
+                            content += `<p class="mb-4">${textHTML}</p>`
                             break;
                         case "heading_1":
                             const headingHTML = block.heading_1.rich_text.map(text => text.plain_text).join("");
-                            content += `<h1>${headingHTML}</h1>`
+                            content += `<h1 class="text-2xl font-bold mb-4">${headingHTML}</h1>`
                             break;
                         case "heading_2":
                             const heading2HTML = block.heading_2.rich_text.map(text => text.plain_text).join("");
-                            content += `<h2>${heading2HTML}</h2>`
+                            content += `<h2 class="text-xl font-bold mb-4">${heading2HTML}</h2>`
                             break;
                         case "heading_3":
                             const heading3HTML = block.heading_3.rich_text.map(text => text.plain_text).join("");
-                            content += `<h3>${heading3HTML}</h3>`
+                            content += `<h3 class="text-lg font-bold mb-4">${heading3HTML}</h3>`
                             break;
                     }
-                    console.log(content)
                 }
                 return {
                     title,