@quesby/boilerplate
v0.3.3
Published
Privacy-first static site boilerplate built with Eleventy and Quesby Core
Maintainers
Readme
Quesby - Privacy-First Static Site Boilerplate
A modern Eleventy boilerplate with Decap CMS, built with content creators in mind.
✨ Features
- Static Site Generation with Eleventy 3.0
- Quesby Core - Built on
@quesby/corenpm package for Eleventy configuration and core functionality - Headless CMS with Decap CMS
- Project Scaffolder (
npx create-quesby) - Create new projects instantly - CLI Tools for content creation (
npx quesby new post) - Modular Theme System with 2 included themes
- Privacy-First approach
- SEO Optimized with automatic sitemaps
- Responsive Design out of the box
- Search Functionality built-in
- Documentation System with TOC generation
- Migration Tools for easy content import
🚀 Quick Start
The easiest way to create a new Quesby project is using the official scaffolder:
# Create a new Quesby project
npx create-quesby my-site
cd my-site
# Install dependencies
pnpm install
# Start development server
pnpm serveVisit http://localhost:8080 to see your site.
Alternative: Clone from Repository
If you prefer to clone the repository directly:
# Clone the repository
git clone https://github.com/quesby/quesby-boilerplate.git
cd quesby-boilerplate
# Install dependencies
pnpm install
# Start development server
pnpm serveNote: This project uses PNPM as package manager. If you don't have pnpm installed, you can use Corepack (comes with Node.js 16.10+):
corepack enable
corepack prepare pnpm@9 --activate🛠️ CLI Tools
Quesby includes a powerful CLI tool for creating new blog posts:
# Create a new blog post
npx quesby new post "My Amazing Post Title"
# The tool will:
# - Generate a unique ULID
# - Create proper folder structure (ULID--slug)
# - Generate complete front matter
# - Set current date automatically📚 Documentation
Complete documentation is available at quesby.dev/documentation including:
🎨 Themes
- quesby-core (default) - Clean, modern design
- quesby-brand-website - Brand-focused layout
🛠️ Available Scripts
pnpm serve- Start development server with CSS watchingpnpm dev- Start development server without CSS watchingpnpm build- Build for productionpnpm run css:watch- Watch CSS changes only
Migration Tools
pnpm run tools:import:dry- Test content import (dry run)pnpm run tools:import:config:dry- Test import with config filepnpm run tools:import:config- Import content with config file
📁 Project Structure
src/
├── content/ # Content files (posts, pages, projects)
├── themes/ # Theme system
├── _includes/ # Nunjucks templates
├── assets/ # Static assets (CSS, JS, images)
└── admin/ # Decap CMS configuration
tools/
├── legacy-content-importer/ # Migration tool for legacy content
└── README.md # Tools documentation🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
📄 License
This project is open source and available under the MIT License.
Acknowledgments
- Built with Eleventy
- CMS powered by Decap CMS
- Icons by Material Symbols
Made with ❤️ for the open source community
💖 Support the Project
If you find Quesby useful, please consider supporting its development:
