VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(markdown): Added missing docs for banner plugin

Browse source
This commit is contained in:
Joost De Cock 2022-01-16 17:31:54 +01:00
parent 8e44616fb5
commit 4b06ccd490
1 changed files with 35 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

35
markdown/dev/reference/plugins/banner/en.md Normal file
View file

@ -0,0 +1,35 @@
---
title: "@freesewing/plugin-banner"
---
The **@freesewing/plugin-banner** plugin provides
[the banner macro](/reference/api/macros/banner).
This macro allows you to add repeating text along a path.
## Example
<Example part="plugin_banner">Example of the banner macro provided by this plugin</Example>
## Installation
```sh
npm install @freesewing/plugin-banner
```
## Usage
Like all [build-time plugins](/guides/plugins/types-of-plugins#build-time-plugins), you
load them by passing them to the [freesewing.Design](/reference/api/design) super-constructor:
```js
import freesewing from "@freesewing/core";
import banner from "@freesewing/plugin-banner";
import config from "../config";
const Pattern = new freesewing.Design(config, banner);
```
Now you can use the
[banner](/reference/api/macros/banner/) macros in your parts.