VibeLog

Appearance

Content Structure ​

Learn how to organize your content for VibeLog, whether using local files or external sources.

File System Content (fs@<path>) ​

When using local content with fs@./content, organize your files as follows:

Directory Structure ​

text
content/
├── blog/           # Blog posts (required)
│   ├── post1.md
│   ├── post2.md
│   └── post3.md
└── author.md       # Author profile (required)

Blog Posts ​

Blog posts should be placed in the blog/ directory as Markdown files.

Frontmatter ​

Each blog post should include frontmatter with metadata:

yaml
---
title: "Your Post Title"
date: "2024-01-15"
slug: "custom-url-slug" # optional, defaults to filename
---
# Your Post Title

Your post content here...

Supported Fields ​

  • title (required) - The post title
  • date (required) - Publication date in YYYY-MM-DD format
  • slug (optional) - Custom URL slug, defaults to filename without .md

Example Post ​

markdown
---
title: "Getting Started with VibeLog"
date: "2024-01-15"
slug: "getting-started"
---

# Getting Started with VibeLog

Welcome to VibeLog! This is your first blog post.

## What is VibeLog?

VibeLog transforms any content source into a production-ready blog...

Author Profile ​

Create an author.md file in the content root with your profile information:

yaml
---
name: "Your Name"
---
This is your longer bio description that supports **Markdown formatting**.

You can include multiple paragraphs, links, and other Markdown elements.

Author Fields ​

  • name (required) - Your display name

The content body supports full Markdown and will be used as the bio.

HackMD Content (hackmd@<username>) ​

When using HackMD as your content source, VibeLog automatically fetches your public notes.

Requirements ​

  • HackMD account with public notes
  • Notes must be published with "View" mode
  • Notes with publication dates are treated as blog posts

How It Works ​

  1. VibeLog fetches your HackMD profile and notes
  2. Only published notes (with "View" mode) are included
  3. Note titles become post titles
  4. Publication dates become post dates
  5. Content is automatically processed to remove duplicate H1 headers

HackMD Profile ​

Your HackMD profile information is automatically used:

  • User accounts: Display name and biography
  • Team accounts: Team name and description

Note Organization ​

  • All published notes become blog posts
  • Notes are sorted by publication date
  • Private or unpublished notes are ignored
  • Note permalinks are preserved when available

Notion Content (notion@<database_id>) ​

Transform your Notion database into a blog by using pages as blog posts.

Notion Requirements ​

  • Notion integration with access to your database
  • Database with pages that contain blog content
  • NOTION_TOKEN environment variable set with your integration token

Notion Integration ​

  1. VibeLog connects to your Notion database using the integration token
  2. All pages in the database become blog posts
  3. Page titles (from title property) become post titles
  4. Page content is converted to Markdown using notion-to-md
  5. Publication dates use custom date properties or creation time
  6. Author info is extracted from database creator and database title

Database Setup ​

Your Notion database should contain pages with the following structure:

Page Properties ​

  • Title - Any property with type "title" (becomes post title)
  • Date - Any property with type "date" (optional, for custom publication date)

If no date property is found, the page creation time will be used.

Page Content ​

  • Page content is automatically converted to Markdown using notion-to-md
  • All Notion blocks (text, headings, lists, etc.) are supported
  • Images and files are processed and included
  • Duplicate H1 headers matching the title are automatically removed

Notion Integration Setup ​

  1. Create a new integration at https://www.notion.so/my-integrations
  2. Copy the integration token
  3. Share your database with the integration
  4. Set the NOTION_TOKEN environment variable
sh
export NOTION_TOKEN=secret_your_notion_integration_token

Common Issues ​

If you encounter errors, VibeLog provides specific error messages to help diagnose issues:

  • Database not found: Check that the database ID is correct and your integration has access
  • Unauthorized: Verify your NOTION_TOKEN and integration permissions
  • Invalid database ID: Ensure the database ID format is correct (32-character string)

Database Organization ​

  • All pages in the database become blog posts
  • Pages are sorted by date (custom date property or creation time)
  • Empty or untitled pages are handled gracefully (titled "Untitled")
  • Page IDs are preserved for reference
  • Author information is extracted from database creator and title