fix(docs): Update plugins documentation
This commit is contained in:
parent
7063d8ab9f
commit
767d835cc6
23 changed files with 272 additions and 51 deletions
|
@ -6,7 +6,28 @@ FreeSewing uses a modular approach where functionality can be extended with
|
|||
plugins. Plugins can provide macros, store methods, or use any of the lifecycle
|
||||
hooks.
|
||||
|
||||
We maintain the following plugins:
|
||||
## Using plugins
|
||||
|
||||
Plugins can be either
|
||||
[added to part configurations](/reference/api/part/config/plugins) in designs or
|
||||
[added to a pattern instance with Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import a plugin for use:
|
||||
```js
|
||||
import { namePlugin } from { @freesewing/plugin-name }
|
||||
// or
|
||||
import { pluginName } from { @freesewing/plugin-name }
|
||||
```
|
||||
|
||||
<Tip>
|
||||
|
||||
For convenience, each plugin is exported in two name formats:
|
||||
"plugin\<Name>" and "\<name\>Plugin".
|
||||
For example, either `pluginBanner` or `bannerPlugin` can be used.
|
||||
|
||||
</Tip>
|
||||
|
||||
## Plugins we maintain
|
||||
|
||||
<ReadMore />
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue