Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📕 docs(none): add community extensions to README.md #2445

Merged
merged 1 commit into from
Sep 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,16 @@

---

## What is bud.js?

Configurable, extensible build tools for modern single and multi-page web applications.

### Goals
## Goals

**bud.js** wants to be:

- **Reliable**, yielding consistent and predictable behaviors regardless of specified options.
- **Fast**, leveraging parallel processing, smart caching and an asyncronous events based API to keep build times minimal.
- **Extensible**, with a fully featured plugin system to support an ecosystem of packaged modules
- **Simple**, to get started and straight forward to maintain
- **Extensible**, with a fully featured plugin system to support an ecosystem of packaged modules.
- **Simple**, to get started and straight forward to maintain.

### Features
## Features

- Zero config by default. Check out this [codesandbox template with react, postcss modules and no config](https://codesandbox.io/s/bud-zero-config-or4tby).
- Modular by design. Use only what you need.
Expand Down Expand Up @@ -119,6 +115,12 @@ Also included in the bud monorepo are packages which are not specific to bud.js
| [**@roots/wordpress-theme-json-webpack-plugin**](https://github.com/roots/bud/tree/main/sources/@roots/wordpress-theme-json-webpack-plugin) | ![npm](https://img.shields.io/npm/v/@roots/wordpress-theme-json-webpack-plugin.svg?color=%23525ddc&style=flat-square) |
| [**@roots/wordpress-transforms**](https://github.com/roots/bud/tree/main/sources/@roots/wordpress-transforms) | ![npm](https://img.shields.io/npm/v/@roots/wordpress-transforms.svg?color=%23525ddc&style=flat-square) |

## Community extensions

| Package | Latest |
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| [**bud-embedded**](https://github.com/roots/bud/tree/main/sources/bud-embedded) | ![npm](https://img.shields.io/npm/v/bud-embedded.svg?color=%23525ddc&style=flat-square) |

## Contributing

Contributions are welcome from everyone.
Expand Down
10 changes: 4 additions & 6 deletions sources/@repo/markdown-kit/readme/partials/what.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
Configurable, extensible build tools for modern single and multi-page web applications.

### Goals
## Goals

**bud.js** wants to be:

- **Reliable**, yielding consistent and predictable behaviors regardless of specified options.
- **Fast**, leveraging parallel processing, smart caching and an asyncronous events based API to keep build times minimal.
- **Extensible**, with a fully featured plugin system to support an ecosystem of packaged modules
- **Simple**, to get started and straight forward to maintain
- **Extensible**, with a fully featured plugin system to support an ecosystem of packaged modules.
- **Simple**, to get started and straight forward to maintain.

### Features
## Features

- Zero config by default. Check out this [codesandbox template with react, postcss modules and no config](https://codesandbox.io/s/bud-zero-config-or4tby).
- Modular by design. Use only what you need.
Expand Down
8 changes: 6 additions & 2 deletions sources/@repo/markdown-kit/readme/templates/root.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{{>banner}}

## What is bud.js?

{{>what}}

## Requirements
Expand Down Expand Up @@ -82,6 +80,12 @@ Also included in the bud monorepo are packages which are not specific to bud.js
| [**@roots/wordpress-theme-json-webpack-plugin**]({{projectConfig.url.web}}/tree/main/sources/@roots/wordpress-theme-json-webpack-plugin) | ![npm](https://img.shields.io/npm/v/@roots/wordpress-theme-json-webpack-plugin.svg?color=%23525ddc&style=flat-square) |
| [**@roots/wordpress-transforms**]({{projectConfig.url.web}}/tree/main/sources/@roots/wordpress-transforms) | ![npm](https://img.shields.io/npm/v/@roots/wordpress-transforms.svg?color=%23525ddc&style=flat-square) |

## Community extensions

| Package | Latest |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| [**bud-embedded**]({{projectConfig.url.web}}/tree/main/sources/bud-embedded) | ![npm](https://img.shields.io/npm/v/bud-embedded.svg?color=%23525ddc&style=flat-square) |

## Contributing

{{>contributing}}
Expand Down
25 changes: 13 additions & 12 deletions sources/@roots/wordpress-hmr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ export const callback = (settings, name) => {
Using a default export

```js title=src/example.filter.js
import {assign} from 'lodash'
import { assign } from "lodash";

export default {
/** Filter id */
Expand All @@ -240,17 +240,18 @@ export default {
hook: `blocks.registerBlockType`,
/** Filter callback */
callback: (settings, name) => {
if (name !== 'core/list') return settings;

return assign({}, settings, {
example: {
innerBlocks: [
{name: 'core/list-item', attributes: {content: 'Item a'}},
{name: 'core/list-item', attributes: {content: 'Item b'}},
],
},
})
}
if (name !== "core/list") return settings;

return assign({}, settings, {
example: {
innerBlocks: [
{ name: "core/list-item", attributes: { content: "Item a" } },
{ name: "core/list-item", attributes: { content: "Item b" } },
],
},
});
},
};
```

## Registering filters from a block or plugin
Expand Down
Loading