Get from zero to published content in 5 minutes. This guide is for content creators who want to focus on writing.
Prerequisites
Before You Start
1/3 complete
- Basic knowledge of Markdown
- Bengal installed
- Terminal/command line access
Create Your Site
Use the interactive wizard:
1 2 | |
Choose a preset that matches your goal (Blog, Documentation, Portfolio, etc.).
Start the Dev Server
bengal serve
Open http://localhost:5173/ in your browser. The dev server automatically rebuilds when you save changes (hot reload).
Create Your First Post
bengal new page my-first-post --section blog
Editcontent/blog/my-first-post.md:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
Save the file. Your new post appears automatically!
Customize Your Site
Editconfig/_default/site.yaml:
1 2 3 4 5 | |
Build for Production
bengal build
Your complete site is inpublic/, ready to deploy!
Deploy
Deploy thepublic/directory to any static hosting:
- Netlify: Build command:
bengal build, Publish:public - GitHub Pages: Use the workflow in Automate with GitHub Actions
- Vercel: Build command:
bengal build, Output:public
Frontmatter Reference
Common frontmatter fields:
| Field | Description |
|---|---|
title |
Page title (required) |
date |
Publication date |
tags |
Tags for taxonomy (e.g.,[python, web]) |
weight |
Sort order (lower = first) |
draft |
trueto hide from builds |
description |
SEO description |
Next Steps
- Build a Blog — Full tutorial
- Content Authoring — Markdown features
- Content Organization — Structure your content
- Type System — Content types and templates
- Theming — Customize appearance
Happy writing! 🎉