breaking: New annotation plugin replaces others
This wraps up the initial work on a new annotations plugin that replaces other plugins that provide annotations. As a result, the following plugins are now no longer available: - plugin-banner - plugin-bartack - plugin-buttons - plugin-cutonfold - plugin-dimension - plugin-grainine - plugin-logo - plugin-notches - plugin-scalebox - plugin-title The new plugin-annotations package provides all these plugins used to provide. In addition, it also includes the following new macros: - bannerbox - pleat - sewTogether
This commit is contained in:
parent
ad18463e2a
commit
d0447c0f77
39 changed files with 655 additions and 926 deletions
45
markdown/dev/reference/plugins/timing/en.md
Normal file
45
markdown/dev/reference/plugins/timing/en.md
Normal file
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: plugin-timing
|
||||
---
|
||||
|
||||
Published as [@freesewing/plugin-timing][1], this plugin measures
|
||||
detailed timing information while drafting a design and keeps it in the
|
||||
pattern store.
|
||||
|
||||
It is intended to be used for developers trying to indicate which parts
|
||||
of their code are slow, or in general provide insights into the speed
|
||||
at which a design can be drafted.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
npm install @freesewing/plugin-timing
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||
design, or [add it to a pattern instance with
|
||||
Pattern.use()](/reference/api/pattern/use).
|
||||
|
||||
To import the plugin for use:
|
||||
```js
|
||||
import { timingPlugin } from '@freesewing/plugin-mirror'
|
||||
// or
|
||||
import { pluginTiming } from '@freesewing/plugin-mirror'
|
||||
```
|
||||
|
||||
<Fixme>
|
||||
|
||||
##### Provide in-depth example
|
||||
|
||||
This is currently not used, but that will change once v3 gets closer to release.
|
||||
At that point, we should provide an in-depth example here.
|
||||
|
||||
</Fixme>
|
||||
|
||||
## Notes
|
||||
|
||||
The mirror plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||
|
||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-timing
|
Loading…
Add table
Add a link
Reference in a new issue