buildawesome-kit

KO | EN

gitlite — search

#javascript #php #java #python #cplusplus #hacktoberfest #erlang #ruby #dotfiles #game #minecraft #couchdb

buildawesome-kit

★ 80 Open GitHub ↗

Lightweight plugin with essential opt-out features, filters, and scripts. Use it standalone OR fully pre-configured with other popular plugins OR via one of our micro-starters 🥷🎈

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Build Awesome Kit

<big>Lightweight plugin with essential opt-out [features](//build.blades.ninja/plugin/features/), [filters](//build.blades.ninja/plugin/filters/), and [scripts](//build.blades.ninja/scripts/).</big>

Use it standalone OR fully pre-configured with other popular plugins OR via one of our micro-starters.

<nav>
 <a href="//build.blades.ninja/plugin/" role="button">Get started </a>
 |
 <a href="//build.blades.ninja/config/" role="button" class="outline">Pre-configured </a>
 |
 <a href="//build.blades.ninja/starters/" role="button" class="outline">Micro-starters 🌱</a>
</nav>

---

## Core package

### Plugin

```sh
npm install @anyblades/buildawesome-kit
```

Then `addPlugin()` to your config:

```js {data-caption=buildawesome.config.js}
import kitPlugin from "@anyblades/buildawesome-kit";

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

Live example: https://github.com/anyblades/buildawesome-micro-starters/blob/main/bare-plugin/

#### Features

All https://build.blades.ninja/plugin/features/ except `mdAutoRawTags` are enabled by default.

You can toggle them like this:

```js {data-caption=buildawesome.config.js}
$config.addPlugin(kitPlugin, {
  autoLinkFavicons: false,
  mdAutoRawTags: true,
});
```

#### Filters

All https://build.blades.ninja/plugin/filters/ are enabled by default.

You can toggle them like this:

```js {data-caption=buildawesome.config.js}
$config.addPlugin(kitPlugin, {
  filters: { attr_set: false },
});
```

---

### Scripts

Ready-to-use npm scripts are included within the same core package:

```sh
npm install @anyblades/buildawesome-kit
```

To reuse in your project, link them under `scripts/` subfolder like this:

```sh
mkdir scripts
cd scripts/
ln -s ../node_modules/@anyblades/buildawesome-kit/packages/scripts/package.json
cd ..
```

Finally, register `scripts` as a "virtual" npm workspace:

```json {data-caption=package.json}
  "workspaces": ["scripts"],
  "scripts": {
    "scripts": "npm -w scripts run",
    "start": "npm run scripts -- start",
    "stage": "npm run scripts -- stage",
    "build": "npm run scripts -- build"
  },
```

**Done!** 🥷
: Build Awesome Kit's `npm run start` / `stage` / `build` are ready to use in your project, AND automatically updated via `@anyblades/buildawesome-kit` package.

Live example: https://github.com/anyblades/buildawesome-micro-starters/tree/main/bare-scripts

---

## Pre-configured

### All-in-one package

```sh
npm install @awesome.me/buildawesome @anyblades/buildawesome-kit-config
```

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

For example, using the built-in base https://blades.ninja/html/ templates:

```sh
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 Kit in action by using its built-in config file:

```sh
npx @awesome.me/buildawesome --serve --config=node_modules/@anyblades/buildawesome-kit-config/buildawesome.config.js
```

Live examples:

- https://github.com/anyblades/buildawesome-micro-starters/tree/main/micro
- https://github.com/anyblades/buildawesome-content-first/tree/main/.build

---

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

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

Now you can simply `npm run start` / `build`! 🥷

Live examples:

- https://github.com/anyblades/buildawesome-micro-starters/blob/main/micro/package.json
- https://github.com/anyblades/buildawesome-content-first/blob/main/.build/package.json

---

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

```js {data-caption=buildawesome.config.js}
import kitConfig from "@anyblades/buildawesome-kit-config";

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

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

Live example: https://github.com/anyblades/buildawesome-micro-starters/blob/main/shotpipe-og-images/buildawesome.config.js

---

### Micro-starters

https://build.blades.ninja/starters/

---

## Documentation

<li>
<a href="//build.blades.ninja/plugin/">Core package</a>
<ul><li><a href="//build.blades.ninja/plugin/">Plugin</a></li>
<li><a href="//build.blades.ninja/scripts/">Scripts</a></li></ul>
</li>

<li>
<a href="//build.blades.ninja/plugin/features/">Features</a>
<ul><li><a href="//build.blades.ninja/plugin/features/">Features overview</a></li>
<li><a href="//build.blades.ninja/plugin/features/link-favicons/">Automatic link favicons</a></li>
<li><a href="//build.blades.ninja/plugin/features/markdown-auto-raw/">Markdown auto-raw tags</a></li>
<li><a href="//build.blades.ninja/plugin/features/markdown-hidden-attrs/">Markdown hidden attrs</a></li>
<li><a href="//build.blades.ninja/plugin/features/markdown-newlines/">Markdown newlines</a></li>
<li><a href="//build.blades.ninja/plugin/features/site-globals/">Site globals</a></li>
<li><a href="//build.blades.ninja/plugin/features/virtual-pages/">Virtual pages NEW</a></li></ul>
</li>

<li>
<a href="//build.blades.ninja/plugin/filters/">Filters</a>
<ul><li><a href="//build.blades.ninja/plugin/filters/">Filters overview</a></li>
<li><a href="//build.blades.ninja/plugin/filters/attr_concat/">attr_concat</a></li>
<li><a href="//build.blades.ninja/plugin/filters/attr_includes/">attr_includes</a></li>
<li><a href="//build.blades.ninja/plugin/filters/attr_set/">attr_set</a></li>
<li><a href="//build.blades.ninja/plugin/filters/date/">date</a></li>
<li><a href="//build.blades.ninja/plugin/filters/fetch/">fetch</a></li>
<li><a href="//build.blades.ninja/plugin/filters/if/">if</a></li>
<li><a href="//build.blades.ninja/plugin/filters/markdownify/">markdownify</a></li>
<li><a href="//build.blades.ninja/plugin/filters/merge/">merge</a></li>
<li><a href="//build.blades.ninja/plugin/filters/remove_tag/">remove_tag</a></li>
<li><a href="//build.blades.ninja/plugin/filters/section/">section</a></li>
<li><a href="//build.blades.ninja/plugin/filters/split/">split NEW</a></li>
<li><a href="//build.blades.ninja/plugin/filters/strip_tag/">strip_tag</a></li>
<li><a href="//build.blades.ninja/plugin/filters/unindent/">unindent</a></li></ul>
</li>

<li>
<a href="//build.blades.ninja/config/">Pre-configured</a>
<ul><li><a href="//build.blades.ninja/config/">All-in-one package</a></li>
<li><a href="//build.blades.ninja/starters/">Starters</a></li>
<li><a href="//build.blades.ninja/templates/">HTML templates</a></li></ul>
</li>

<li>
<a href="//build.blades.ninja/awesome/">Awesome</a>

</li>

</ul>

---

## Featured by

- [11tybundle.dev](https://11tybundle.dev/starters/#:~:text=build%20awesome%20kit)
- [sveltiacms.app](https://sveltiacms.app/en/docs/frameworks/eleventy#:~:text=anyblades)
- [@hamatti](https://hamatti.org/posts/markdown-content-split-to-sections-in-eleventy-and-nunjucks/#:~:text=section%20filter)

buildawesome-kit

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README