11ty / Build Awesome One

All-in-One kit for 11ty / Build Awesome.

One Plugin › | One Config › | One Starter ↗

---

One utility Plugin

npm install @buildawesome.one/plugin

Then addPlugin() in your config:

import onePlugin from "@buildawesome.one/plugin";

export default function ($config) {
  $config.addPlugin(onePlugin);
}

Live examples:

• https://github.com/buildawesome-one/kit/tree/main/plugin/e2e
• https://github.com/buildawesome-one/kit/tree/main/config

Plugin features

All https://buildawesome.one/plugin/features/ except mdAutoRawTags are included by default, but you can toggle them like this:

$config.addPlugin(onePlugin, {
  autoLinkFavicons: false,
  mdAutoRawTags: true,
});

Plugin filters

All https://buildawesome.one/plugin/filters/ are included by default, but you can toggle them like this:

$config.addPlugin(onePlugin, {
  filters: { attr_set: false },
});

---

All-in-One Config

npm install @awesome.me/buildawesome @buildawesome.one/config

Everything is installed automatically; the only manual step is to create a default layout.

For example, using the built-in Blades templates:

mkdir _includes
cd _includes/
ln -s ../node_modules/@anyblades/blades/_includes/blades
echo "{% extends 'blades/html.njk' %}{% set site = { styles: ['https://cdn.jsdelivr.net/npm/@anyblades/blades@2/css/blades.min.css'] } %}" > default.njk
cd ..
echo "Hello, world! 🎈" > index.md

Done! 🥷 : Now you can see the Build Awesome One in action by using its own built-in config:

npx @awesome.me/buildawesome --serve --config=node_modules/@buildawesome.one/config/buildawesome.config.js

---

If you don't want to type --config=... every time, save it in your package.json:

"scripts": {
  "build": "buildawesome --config=node_modules/@buildawesome.one/config/buildawesome.config.js",
  "start": "npm run build -- --serve"
}

Now you can simply npm run start / build! 🥷

Live examples:

• https://github.com/buildawesome-one/kit/tree/main/config/e2e
• https://github.com/buildawesome-one/starter/tree/main/.build
• https://github.com/buildawesome-one/examples

---

You can also import and use it as a base config:

import oneConfig from "@buildawesome.one/config";

export default async function ($config) {
  await oneConfig($config);

  // Customize $config further as you like:
  $config.addPlugin(...);
}

Live example: https://github.com/buildawesome-one/examples/tree/main/og-images

---

One Starter

https://starter.buildawesome.one/

---

All-in-One Examples

https://github.com/buildawesome-one/examples

---

Documentation

• Plugin
  • Install
  • Features
    • Automatic link favicons
    • Markdown auto-raw tags
    • Markdown hidden attrs
    • Markdown newlines
    • Site globals
    • Virtual pages NEW
  • Filters
    • attr_concat
    • attr_includes
    • attr_set
    • date
    • fetch
    • if
    • markdownify
    • merge
    • remove_tag
    • section
    • split NEW
    • strip_tag
    • unindent
• Config
• Starter ↗
• More
  • Awesome
  • CLI
  • Starters
  • Templating
  • Examples ↗

---

^{Featured by}

• 11ty.dev
• 11tybundle.dev
• blades.ninja
• sveltiacms.app
• https://github.com/adamdjbrett/000000076
• https://github.com/eggplantpasta/greenroom
• @hamatti