Statue

Statue is a wicked-fast static site generator based on Markdown, Svelte, Tailwind, Pagefind, and reusable components.

One-line setup! (requires npm):

yes | npx sv create statue-site --template minimal --types ts --no-add-ons --install npm && cd statue-site && npm install statue-ssg && npx statue init && npm install && npm run build && npm run preview

bun:

yes | npx sv create statue-site --template minimal --types ts --no-add-ons --install bun && cd statue-site && bun add statue-ssg && npx statue init && bun install && bun run build && bun run preview

pnpm:

yes | npx sv create statue-site --template minimal --types ts --no-add-ons --install pnpm && cd statue-site && pnpm add statue-ssg && npx statue init && pnpm install && pnpm run build && pnpm run preview

yarn:

yes | npx sv create statue-site --template minimal --types ts --no-add-ons --install yarn && cd statue-site && yarn add statue-ssg && npx statue init && yarn install && yarn run build && yarn run preview

Windows: Support for Windows is provided on a best-effort basis. Statue's dev team lacks regular Windows users, so we cannot easily keep Statue working seemlessly for Windows: contact us if you'd like to help maintain Statue support for Windows! The above commands should work, but you may run into pathing issues and other incompatibilities during or after setup.

Content like blogs and docs are added and changed directly through .md files. Other parts of the Statue site are based on Svelte components and the site's config. Statue sites are fully static, so development is straightforward, management is simple, and hosting is ~free!

Need help? Want to collaborate, contribute, or engage with the Statue community? Join us on Discord! 🗿

Why Statue?

Statue is Fast, Simple, and Flexible from start to finish. One-line setup, then fast builds, fast deploys, and a fast site.

• Markdown-first: Write your site's content in simple .md files: no coding required.
• Zero Config, Zero Cost Search: Start with your own full-site search index: no setup, totally free and yours.
• Powered by Great Tools: 0->1 setup with SvelteKit, Tailwind, Pagefind, and components fully integrated.
• Simple yet Powerful: Statue's Declarative Component Model makes customization easy, intuitive, and flexible.
• Ultra-cheap hosting: Deploy static sites to free and low-cost hosts like Netlify, Vercel, Cloudflare, and GitHub Pages.
• Low Maintenance: Static sites are ~maintenance-free; Statue keeps sites simple with less to break.

Statue helps you build the site you want, without battling the tools you use to build it.

Getting Started

After running the setup command above, your site is live at http://localhost:3000.

Next steps:

1. Complete the New Site Checklist - Customize your site step-by-step
2. Read Getting Started - Learn key concepts
3. Add content - Create .md files in content/ and they become pages automatically

Documentation

📚 For Users

• Getting Started - Key concepts and quick start
• New Site Checklist - Step-by-step customization guide
• Site Configuration - Configure site.config.js
• Themes - Built-in themes and customization
• Components - Component reference
• Templates - Using templates
• Routing - How URLs work

🔧 For Developers

• Development Guide - Architecture and internals
• Contributing - How to contribute
• Components API - Full component reference
• Themes API - Creating custom themes

Modifying your Site

Make changes to your site's contents, config, and code, then run npm run build (or equivalent) to rebuild it.

To resolve new imports, handle the build, and view your new site all in one command, try:

npm i && npm run build && npm run preview

Once you're ready to publish your site, deploy the build/ directory to any static host. See deployment guide →

Community

• Discord - Chat with the community
• GitHub Issues - Report bugs or request features
• GitHub Discussions - Ask questions

License

MIT