freesewing/markdown/dev/reference/plugins/scalebox/en.md

---
title: plugin-scalebox
---

Published as [@freesewing/plugin-scalebox][1], this plugin provides the
[scalebox](/reference/macros/scalebox) and
[miniscale](/reference/macros/miniscale) macros which add a (mini) scalebox
to your design, so users can verify that the pattern is printed at the correct
scale.

## Installation

```sh
npm install @freesewing/plugin-scalebox
```

## 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).

## Notes

This plugin by default includes FreeSewing branding, but you can
override that when calling the scalebox macro in case you want to
generate your own branded designs.

The scalebox plugin is part of our [plugin-bundle](/reference/plugins/bundle)

[1]: https://www.npmjs.com/package/@freesewing/plugin-scalebox
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81. 2021-10-17 18:26:00 +02:00			`---`
chore(markdown): Some more tweaks to reference docs 2022-10-02 18:07:36 +02:00			`title: plugin-scalebox`
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81. 2021-10-17 18:26:00 +02:00			`---`
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00
chore(markdown): Updated Plugin docs for v3 2022-10-02 00:27:09 +02:00			`Published as [@freesewing/plugin-scalebox][1], this plugin provides the`
chore(markdown): Updated links for v3 2022-10-12 19:09:04 +02:00			`[scalebox](/reference/macros/scalebox) and`
			`[miniscale](/reference/macros/miniscale) macros which add a (mini) scalebox`
chore(markdown): Updated Plugin docs for v3 2022-10-02 00:27:09 +02:00			`to your design, so users can verify that the pattern is printed at the correct`
			`scale.`
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00
			`## Installation`

chore(markdown): Updated Plugin docs for v3 2022-10-02 00:27:09 +02:00			```sh
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00			`npm install @freesewing/plugin-scalebox`
			```

			`## Usage`

chore(markdown): Updated Plugin docs for v3 2022-10-02 00:27:09 +02:00			`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).`
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00
chore(markdown): Updated Plugin docs for v3 2022-10-02 00:27:09 +02:00			`## Notes`
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00
chore(markdown): Updated Plugin docs for v3 2022-10-02 00:27:09 +02:00			`This plugin by default includes FreeSewing branding, but you can`
			`override that when calling the scalebox macro in case you want to`
			`generate your own branded designs.`

			`The scalebox plugin is part of our [plugin-bundle](/reference/plugins/bundle)`

			`[1]: https://www.npmjs.com/package/@freesewing/plugin-scalebox`
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown 2021-08-25 16:09:31 +02:00