Getting Started
VibeLog transforms any content source into a production-ready blog with AI-powered styling. Get up and running in minutes.
Prerequisites
- Node.js v20+
- AI provider API key (or use Ollama without API key)
Quick Start
1. Create Your Blog Directory
mkdir your-blog && cd your-blog2. Preview Your Content
Start the development server to preview your content and experiment with AI-powered styling:
# Set your OpenAI API key
export OPENAI_API_KEY=<your_openai_api_key>
# Start dev server with HackMD content
npx vibelog dev --content hackmd@<your_username> --ai openai@gpt-4o-miniNavigate to http://localhost:5566 and use the vibelog panel to modify styles with AI prompts like:
- "dark theme with pink accents"
- "minimal design with green colors"
- "corporate blue theme"
3. Build Production Site
Once you're happy with your design, build the production-ready site:
npx vibelog build --site-url https://your-blog.comThis generates a static site in the dist directory.
4. Deploy
Deploy your site using any static hosting service:
# Example with Surge
npx surge dist
# Or with Vercel
npx vercel dist
# Or with Netlify
npx netlify deploy --prod --dir distContent Sources
VibeLog supports multiple content sources:
File System
Use local markdown files:
vibelog dev --content fs@./my-content --ai ollama@qwen2.5-coder:3bYour content directory should have this structure:
my-content/
├── blog/
│ ├── post1.md
│ ├── post2.md
│ └── post3.md
└── author.mdHackMD
Turn your HackMD workspace public notes into a blog:
vibelog dev --content hackmd@<your_username> --ai anthropic@claude-3-5-haiku-20241022Notion
Transform your Notion database pages into a blog:
# Set your Notion integration token
export NOTION_TOKEN=<your_notion_token>
# Use Notion database as content source
vibelog dev --content notion@<database_id> --ai openai@gpt-4o-miniNote: Make sure your Notion integration has access to the database and the database ID is correct. VibeLog will provide helpful error messages if there are authentication or permission issues.
NOTE
More content sources will be supported in the future
AI Providers
VibeLog supports multiple AI providers for styling:
# OpenAI
export OPENAI_API_KEY=<your_openai_api_key>
--ai openai@gpt-4o-mini
# Anthropic
export ANTHROPIC_API_KEY=<your_anthropic_api_key>
--ai anthropic@claude-3-5-haiku-20241022
# Google
export GOOGLE_GENERATIVE_AI_API_KEY=<your_google_api_key>
--ai google@gemini-2.5-flash
# OpenRouter
export OPENROUTER_API_KEY=<your_openrouter_api_key>
--ai openrouter@qwen/qwen-2.5-coder-32b-instruct:free
# Ollama (local, no API key needed)
--ai ollama@qwen2.5-coder:3bNext Steps
- CLI Reference - Complete command reference
- Content Structure - Learn about content organization
- Styling Guide - Advanced styling techniques