From 6e0d9a47d91e31a0839f0527bc9d761d18dad127 Mon Sep 17 00:00:00 2001 From: Kelly Mears Date: Tue, 12 Sep 2023 12:29:00 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=95=20docs(none):=20add=20community=20?= =?UTF-8?q?extensions=20to=20README.md=20(#2445)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## Type of change **NONE: internal change** --- README.md | 18 +++++++------ .../markdown-kit/readme/partials/what.md | 10 +++----- .../markdown-kit/readme/templates/root.md | 8 ++++-- sources/@roots/wordpress-hmr/README.md | 25 ++++++++++--------- 4 files changed, 33 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 18bd2e7945..41c946b412 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. diff --git a/sources/@repo/markdown-kit/readme/partials/what.md b/sources/@repo/markdown-kit/readme/partials/what.md index 74d0de5b85..b15c765d27 100644 --- a/sources/@repo/markdown-kit/readme/partials/what.md +++ b/sources/@repo/markdown-kit/readme/partials/what.md @@ -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. diff --git a/sources/@repo/markdown-kit/readme/templates/root.md b/sources/@repo/markdown-kit/readme/templates/root.md index 3a5cf630a7..ffb3a6f1e0 100644 --- a/sources/@repo/markdown-kit/readme/templates/root.md +++ b/sources/@repo/markdown-kit/readme/templates/root.md @@ -1,7 +1,5 @@ {{>banner}} -## What is bud.js? - {{>what}} ## Requirements @@ -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}} diff --git a/sources/@roots/wordpress-hmr/README.md b/sources/@roots/wordpress-hmr/README.md index 0bae911541..c4068d6893 100644 --- a/sources/@roots/wordpress-hmr/README.md +++ b/sources/@roots/wordpress-hmr/README.md @@ -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 */ @@ -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