Statue Readme

Statue is a blazingly-fast static site generator based on Markdown, SvelteKit, and a component library.

One-line setup:

yes | npx sv create . --template minimal --types ts --no-add-ons --install npm && npm install statue-ssg && npx statue init && npm install && npm run dev

Content like blogs and documentation can be added and modified directly through .md files, with pages and the site structure itself based on Svelte components. Statue sites are fully static, so management is simple, development can be non-technical, and hosting is cheap or free. Join us on Discord! 🗿

Why Statue?

Statue is Fast, Simple, and Flexible from start to finish. It takes only one command to get started, builds and deployments are fast, hosting is simple, sites are extensible, and developing a Statue site is about building what you want rather than battling, learning, and conforming to the tool itself.

• Markdown-first: Build out your site content by writing .md files: no coding required.
• Powered by SvelteKit: Familiar Svelte features and ecosystem, based on an elegant declarative model ideal for static sites.
• Tailwind + Components: Customize the UI easily with Tailwind CSS, and a library of included components.
• Easy to Use and Extend: The Declarative Component Model is easy to use, and with LLMs, easy for even non-technical users to work with.
• Ultra-cheap hosting: Deploy static output to Netlify, Vercel, Cloudflare Pages, GitHub Pages, etc.
• Low Maintenance: Static sites are almost maintenance-free, and Statue itself is much less complex than other web tools.

Getting Started

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

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

Deploy

Build and deploy your static site:

npm run build

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