Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 44 additions & 30 deletions src/site/generators/statue.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Statue SSG
repo: https://github.com/accretional/statue
repo: accretional/statue
homepage: https://statue.dev/
language:
- Svelte
Expand All @@ -9,50 +9,64 @@ license:
templates:
- Svelte
- Markdown
description: Extremely fast and simple Static Site generation with Sveltekit and Markdown
description: Fast, single-command static site generation via Sveltekit + Markdown. Perfect for agents.
---
Statue is a blazingly-fast static site generator based on Sveltekit, Markdown, Tailwind, and a bundled component library.

One-line is all it takes to start building your site with Statue!
Statue is a wicked-fast static site generator based on Markdown, Svelte, Tailwind, Pagefind, and reusable components.

**One-line setup! (requires npm):**
```bash
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
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
```

## Why Statue?
Above all else, 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.
<details>
<summary>setup via bun, pnpm, yarn, windows</summary>

**bun**:

- **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.
```bash
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
```

Statue meets the needs of multiple kinds of use cases and users. Even non-developers can write markdown files and use AI to build and customize Statue sites. Statue's design is intentionally highly structured, self-contained, and based on simple-yet-familiar web technologies, so that LLMs could productively contribute to it even when guided by non-technical users. That same commitment to order and constrained complexity makes it great for developers, too: they can spend less time on the tool itself, and more time building.
**pnpm**:

## Templates
```bash
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
```

Statue's default template is intended to model a SaaS landing page. To create a Statue site using a blog-based template, try running
**yarn**:

```bash
npx statue init --template blog
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
```

## Components
**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.

Statue includes a web component library that can be used independently of Statue's static site generation features. You can find a full list of supported components in Statue's github repo at [src/lib/components](https://github.com/accretional/statue/tree/main/src/lib/components)
---
</details>

To use Statue Svelte components, run ```npm install statue-ssg``` and then add it to your .svelte file:
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!**

```svelte
<script lang="ts">
import {BuiltBy} from 'statue-ssg';
// your typescript
</script>
<!-- your svelte -->
<BuiltBy builtInIcon={"/favicon.png"} />
<!-- the rest of your svelte -->
```
## What is Statue

Statue is a static site generator with built in support, and a strong default set of choices for:

* Components
* Templates
* Themes
* Full-site search and search indexing
* Agentic Site Generation

The official site and docs are at [statue.dev](https://statue.dev), the github repo is at [github.com/accretional/statue](https://github.com/accretional/statue), and the discord is at [discord.gg/accretional](https://discord.gg/accretional)

## 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.

Contributions to Statue's ssg functionality, templates, and component library are welcomed and very much appreciated!
Statue helps you build the site you want, without battling the tools you use to build it.