Skip to content
Get packs

Guide · Open source

How to use buildawesome: install it and build plain HTML

Updated · written with AI from the project's own documentation and checked against our catalogue data

Build Awesome (Eleventy) is an open-source static site generator written in JavaScript. It takes a folder of templates and turns them into plain HTML files that you can host anywhere. This guide explains what it does, how to install it with npm, and who it suits, so you can decide whether to try it.

Eleventy11ty/buildawesome · ★ 20k · MIT

Quick start

  1. 1Check prerequisites. Make sure Node.js and npm are installed, since the README lists Node.js as the prerequisite.
  2. 2Install the package. Run npm install @awesome.me/buildawesome --save-dev in your project folder.
  3. 3Read the Getting Started guide. Follow the Getting Started guide at 11ty.dev for the build workflow and project setup.
  4. 4Create your templates. Write pages in HTML, Markdown, Liquid or Nunjucks in a folder for the generator to process.
  5. 5Add addons if needed. Install an addon such as Sass or Vue if your templates need it, using the plugins documentation as a reference.
  6. 6Build and host the output. Generate the site as described in the docs, then upload the resulting plain HTML files to any host.

What does buildawesome do?

buildawesome transforms a directory of templates into HTML. The README describes it as a simpler static site generator and an alternative to Jekyll.

It works with HTML, Markdown, JavaScript, Liquid and Nunjucks templates. Addons are available for WebC, Sass, Vue, Svelte, TypeScript, JSX and other formats.

  • Input: a folder of templates in formats such as HTML, Markdown, Liquid or Nunjucks
  • Output: plain HTML files
  • Hosting: the output can be hosted anywhere, since it is static

What do you need before you install buildawesome?

The install method is through a package manager, and the stated prerequisite is Node.js. You should be comfortable working with npm and Node.js projects and using the command line.

If you want a point-and-click website builder, this tool is not designed for that. It is driven by the command line and by templates.

  • Node.js installed
  • npm available for installing packages
  • Comfort with the command line

How do you install buildawesome with npm?

The README shows installing buildawesome as a dev dependency in your project with npm. The --save-dev flag adds it to your development dependencies.

The README also notes that the package is backwards compatible with the older @11ty/eleventy name, which can be installed the same way.

For the full setup walkthrough, read the Getting Started guide linked from the README.

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

How do you add features with plugins and addons?

Beyond the core formats, the README says addons exist for formats such as WebC, Sass, Vue, Svelte, TypeScript and JSX. Plugin details are in the official docs.

Check the plugins documentation before you start a project that depends on a specific format, so you know which addon to install.

  • Plugins guide: https://www.11ty.dev/docs/plugins/
  • Documentation: https://www.11ty.dev/docs/

Where can you learn more about the project?

The main documentation is at 11ty.dev, and the project homepage is build.awesome.me. The README also links to a Discord chat and to the project's GitHub issues and discussions for bugs and feature requests.

  • Homepage: https://build.awesome.me/
  • Getting Started guide: https://www.11ty.dev/docs/getting-started/
  • Discord chat: https://www.11ty.dev/blog/discord/

What people use it for

  • A developer building a lightweight documentation site from Markdown files
  • A blogger who writes posts in Markdown and wants plain HTML output
  • A JavaScript developer who wants a simpler alternative to Jekyll for a static site
  • A team using Nunjucks or Liquid templates to produce a set of static pages

Frequently asked questions

Is buildawesome free to use?

buildawesome is released under the MIT licence, as stated in the project information. You can check the licence file in the repository for the full terms.

What do I need to run buildawesome?

The stated prerequisite is Node.js, and you install the package with npm. It is a command-line tool driven by templates, so basic terminal skills help.

Is buildawesome the same as Eleventy?

The project is called Build Awesome (Eleventy) in its README, and the older @11ty/eleventy package name is also listed as a backwards compatible install.

How is buildawesome different from Jekyll?

The README describes buildawesome as a simpler static site generator and an alternative to Jekyll. Other comparable projects mentioned are Hugo and Astro.

Can buildawesome build a site with a database?

No. It produces static HTML files, so it is not suited to dynamic server-side applications that need a database.

Does buildawesome support Markdown?

Yes. The README lists Markdown among the supported template formats, along with HTML, JavaScript, Liquid and Nunjucks.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Choose buildawesome if you are a JavaScript developer who wants a lighter static site generator than Jekyll and writes Markdown or HTML templates. Pick a different tool if you want a point-and-click builder or a dynamic site with a database, since this project outputs static HTML from the command line.

Install options & downloads