Skip to content

Commit 6ed2244

Browse files
authored
Fix and update statue.md (#1052)
* Fix and update statue.md Fix statue github repo frontmatter, update description to reflect current README.md in https://github.com/accretional/statue * Remove Markdown from language list in statue.md
1 parent 4207845 commit 6ed2244

1 file changed

Lines changed: 44 additions & 30 deletions

File tree

src/site/generators/statue.md

Lines changed: 44 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Statue SSG
3-
repo: https://github.com/accretional/statue
3+
repo: accretional/statue
44
homepage: https://statue.dev/
55
language:
66
- Svelte
@@ -9,50 +9,64 @@ license:
99
templates:
1010
- Svelte
1111
- Markdown
12-
description: Extremely fast and simple Static Site generation with Sveltekit and Markdown
12+
description: Fast, single-command static site generation via Sveltekit + Markdown. Perfect for agents.
1313
---
14-
Statue is a blazingly-fast static site generator based on Sveltekit, Markdown, Tailwind, and a bundled component library.
1514

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

17+
**One-line setup! (requires npm):**
1818
```bash
19-
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
19+
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
2020
```
2121

22-
## Why Statue?
23-
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.
22+
<details>
23+
<summary>setup via bun, pnpm, yarn, windows</summary>
24+
25+
**bun**:
2426

25-
- **Markdown-first**: Build out your site content by writing `.md` files: no coding required.
26-
- **Powered by SvelteKit**: Familiar Svelte features and ecosystem, based on an elegant declarative model ideal for static sites.
27-
- **Tailwind + Components**: Customize the UI easily with Tailwind CSS, and a library of included components.
28-
- **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.
29-
- **Ultra-cheap hosting**: Deploy static output to Netlify, Vercel, Cloudflare Pages, GitHub Pages, etc.
30-
- **Low Maintenance**: Static sites are almost maintenance-free, and Statue itself is much less complex than other web tools.
27+
```bash
28+
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
29+
```
3130

32-
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.
31+
**pnpm**:
3332

34-
## Templates
33+
```bash
34+
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
35+
```
3536

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

3839
```bash
39-
npx statue init --template blog
40+
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
4041
```
4142

42-
## Components
43+
**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.
4344

44-
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)
45+
---
46+
</details>
4547

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

48-
```svelte
49-
<script lang="ts">
50-
import {BuiltBy} from 'statue-ssg';
51-
// your typescript
52-
</script>
53-
<!-- your svelte -->
54-
<BuiltBy builtInIcon={"/favicon.png"} />
55-
<!-- the rest of your svelte -->
56-
```
50+
## What is Statue
51+
52+
Statue is a static site generator with built in support, and a strong default set of choices for:
53+
54+
* Components
55+
* Templates
56+
* Themes
57+
* Full-site search and search indexing
58+
* Agentic Site Generation
59+
60+
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)
61+
62+
## Why Statue?
63+
Statue is **Fast, Simple, and Flexible from start to finish**. One-line setup, then fast builds, fast deploys, and a fast site.
64+
65+
- **Markdown-first**: Write your site's content in simple `.md` files: no coding required.
66+
- **Zero Config, Zero Cost Search:** Start with your own full-site search index: no setup, totally free and yours.
67+
- **Powered by Great Tools**: 0->1 setup with SvelteKit, Tailwind, Pagefind, and components fully integrated.
68+
- **Simple yet Powerful**: Statue's Declarative Component Model makes customization easy, intuitive, and flexible.
69+
- **Ultra-cheap hosting**: Deploy static sites to free and low-cost hosts like Netlify, Vercel, Cloudflare, and GitHub Pages.
70+
- **Low Maintenance**: Static sites are ~maintenance-free; Statue keeps sites simple with less to break.
5771

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

0 commit comments

Comments
 (0)