pagebrew
v1.4.0
Published
Pagebrew is a CLI tool for creating static sites from markdown files
Downloads
75
Maintainers
Readme
Pagebrew
Pagebrew is a static site generator for your markdown files.
Features
- Generate a static site from Markdown files
- Use Tailwind CSS for styling
- Use EJS for templates
- Deploy the site to a static host
Usage
Serve the site locally
npx pagebrew serve
Build the site
npx pagebrew build
Preview the production build
npx pagebrew preview
Configuration
pagebrew.config.json
is the configuration file for Pagebrew. It is used to set the theme, output directory, and other options.
{
"name": "My Site",
"description": "A static site generated by Pagebrew",
"theme": "minimal",
"outputDir": "dist",
"menu": [
{
"title": "Home",
"url": "/"
},
{
"title": "About",
"url": "/about.html"
},
{
"title": "Blog",
"url": "/blog.html"
}
]
}
Theming
Pagebrew comes with a minimal theme by default. You can use the -t
option to specify a different theme.
Available themes:
npx pagebrew serve -t aurora
You can override the theme files by creating your own in the templates
directory.
Copy the theme you want to use into the templates
directory.
Directory structure:
index.md
about.md
templates/
partials/
header.ejs
footer.ejs
index.ejs
base.ejs
about.ejs
pagebrew.config.json
...
Deployment (WIP)
- Cloudflare Pages
- Vercel
- Netlify
- GitHub Pages