|
| 1 | +--- |
| 2 | +title: Statue SSG |
| 3 | +repo: https://github.com/accretional/statue |
| 4 | +homepage: https://statue.dev/ |
| 5 | +language: |
| 6 | + - Svelte |
| 7 | +license: |
| 8 | + - MIT |
| 9 | +templates: |
| 10 | + - Svelte |
| 11 | + - Markdown |
| 12 | +description: Extremely fast and simple Static Site generation with Sveltekit and Markdown |
| 13 | +--- |
| 14 | +Statue is a blazingly-fast static site generator based on Sveltekit, Markdown, Tailwind, and a bundled component library. |
| 15 | + |
| 16 | +One-line is all it takes to start building your site with Statue! |
| 17 | + |
| 18 | +```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 |
| 20 | +``` |
| 21 | + |
| 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. |
| 24 | + |
| 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. |
| 31 | + |
| 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. |
| 33 | + |
| 34 | +## Templates |
| 35 | + |
| 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 | + |
| 38 | +```bash |
| 39 | +npx statue init --template blog |
| 40 | +``` |
| 41 | + |
| 42 | +## Components |
| 43 | + |
| 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 | +To use Statue Svelte components, run ```npm install statue-ssg``` and then add it to your .svelte file: |
| 47 | + |
| 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 | +``` |
| 57 | + |
| 58 | +Contributions to Statue's ssg functionality, templates, and component library are welcomed and very much appreciated! |
0 commit comments