buildawesome README

The project's README from github.com/11ty/buildawesome. As one markdown file: README.md.

Build Awesome (balloon) and 11ty Logo

Build Awesome (Eleventy) ๐Ÿ•šโšก๏ธ๐ŸŽˆ๐Ÿ€

A simpler static site generator. An alternative to Jekyll. Written in JavaScript. Transforms a directory of templates (of varying types) into HTML.

Works with HTML, Markdown, JavaScript, Liquid, Nunjucks, with addons for WebC, Sass, Vue, Svelte, TypeScript, JSX, and many others!

โžก Documentation

Installation

npm install @awesome.me/buildawesome --save-dev

# Backwards compatible here too:
npm install @11ty/eleventy --save-dev

Read our Getting Started guide.

Tests

npm test

We have a few test suites, for various reasons:

These run in various environments:

Community Roadmap

Plugins

See the official docs on plugins.

buildawesome (11ty/buildawesome)

Searching Databaseโ€ฆ

20K ยทGitHub
What is this?Buildawesome (Eleventy) is a static site generator that transforms a directory of templates into HTML, positioned as a simpler alternative to Jekyll.
Is this a framework like Jekyll, or something different?It is a Node.js-based static site generator (CLI tool), built as an alternative to Jekyll but written in JavaScript instead of Ruby.
How do I install it and build a site?You install it from npm and follow the Getting Started guide in the official docs to scaffold and build your site.
What Node.js version do I need?The project requires Node.js version 22.15 or newer, per the engines field in its package configuration.
Does it support things like Sass, Vue, or TypeScript out of the box?Core support covers HTML, Markdown, JavaScript, Liquid and Nunjucks; WebC, Sass, Vue, Svelte, TypeScript and JSX require official addon plugins.
What templating languages does it handle natively?Out of the box it works with HTML, Markdown, JavaScript, Liquid, and Nunjucks templates, with more formats available via official plugins.
How is the project tested?It uses multiple test suites: the AVA test runner and Node's built-in test runner for server-side code, plus Vitest in browser mode for browser-specific packages.
Where can I find all the available plugins?The official documentation has a dedicated plugins page listing addons like Sass, Vue, Svelte, TypeScript, and JSX support.
What are similar projects?hugo, zola, react-static, gridea, vuepress, docz, mdBook, decap-cms
Creator
11ty
Size
6.9 MB
Stars
20K
Age
8y
Commits ยท 90 Days