diff --git a/CHANGELOG.md b/CHANGELOG.md index 553ecb3..f36f39d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,26 @@ +## 2.1.0-beta.2 (2024-11-29) + +* chore: update `fileExtension` type 410d21e + +## 2.1.0-beta.1 (2024-11-29) + +* test: update tests 2c69ad8 +* feat: support `fileExtension` as array 5175272 +* refactor: use native for loops instead of lodash/each bcd80ef +* build(deps-dev): bump @vitest/coverage-v8 from 2.1.5 to 2.1.6 e07feae +* build(deps-dev): bump @biomejs/biome from 1.9.3 to 1.9.4 6e6323d +* build(deps): bump posthtml-parser from 0.12.0 to 0.12.1 e4f7e73 +* build(deps): bump style-to-object from 1.0.7 to 1.0.8 ad81c84 +* build(deps-dev): bump markdown-it-anchor from 9.1.0 to 9.2.0 0fbfcfa + +## 2.0.0 (2024-07-25) + +* **[BREAKING]** Node.js 18+ 907de89 +* **[BREAKING]** renamed `blacklistAttributes` to `blocklistAttributes` 0cd302e +* migrate to Vitest 8cb2619 +* fixed test for `posthtml-include` latest version 3d168d4 +* feat: add types 7feb3af + ## 2.0.0-beta.2 (2024-07-25) * 2.0.0-beta.2 ([8078cce](https://github.com/posthtml/posthtml-components/commit/8078cce)) @@ -298,6 +321,3 @@ * Update readme ([42fa034](https://github.com/posthtml/posthtml-components/commit/42fa034)) * Update version ([0599426](https://github.com/posthtml/posthtml-components/commit/0599426)) * Update version ([27ab49c](https://github.com/posthtml/posthtml-components/commit/27ab49c)) - - - diff --git a/README.md b/README.md index 8f6d782..371f4cc 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,40 @@ If you are familiar with Blade, React, Vue or similar, you will find the syntax **See also the first [PostHTML Bootstrap UI](https://github.com/thewebartisan7/posthtml-bootstrap-ui) using this plugin and check also the [starter template here](https://github.com/thewebartisan7/posthtml-bootstrap-ui-starter).** +## Options + +| Name | Type | Default | Description | +|--------------------------|--------------------|----------------------------------------------|----------------------------------------------------------------------------------| +| **root** | `String` | `'./'` | Root path where to look for components. | +| **folders** | `String[]` | `['']` | Array of paths relative to `options.root` or defined namespaces. | +| **fileExtension** | `String\|String[]` | `'html'` | Component file extensions to look for. | +| **tagPrefix** | `String` | `'x-'` | Tag prefix. | +| **tag** | `String\|Boolean` | `false` | Component tag. Use with `options.attribute`. Boolean only `false`. | +| **attribute** | `String` | `'src'` | Attribute to use for defining path to component file. | +| **namespaces** | `String[]` | `[]` | Array of namespace root paths, fallback paths, and custom override paths. | +| **namespaceSeparator** | `String` | `'::'` | Namespace separator for tag names. | +| **yield** | `String` | `'yield'` | Tag name for injecting main component content. | +| **slot** | `String` | `'slot'` | Tag name for [slots](#slots) | +| **fill** | `String` | `'fill'` | Tag name for filling slots. | +| **slotSeparator** | `String` | `':'` | Name separator for `` and `` tags. | +| **stack** | `String` | `'stack'` | Tag name for [``](#stacks). | +| **push** | `String` | `'push'` | Tag name for ``. | +| **propsScriptAttribute** | `String` | `'props'` | Attribute in `