Merge pull request #3390 from BenJamesBen/different-environements-docs-fix
fix(docs): Updates and corrections for FreeSewing in different environments
This commit is contained in:
commit
2dafd6a65f
3 changed files with 16 additions and 12 deletions
|
@ -11,11 +11,12 @@ you can generate patterns in the browser with a few lines of JavaScript.
|
||||||
##### Use FreeSewing.org if you just want a pattern
|
##### Use FreeSewing.org if you just want a pattern
|
||||||
|
|
||||||
These instructions are intended for people who want to generate
|
These instructions are intended for people who want to generate
|
||||||
their own patterns. If you _just want a sewing pattern_ you can
|
their own patterns using FreeSewing packages.
|
||||||
get all our designs on [FreeSewing.org](https://FreeSewing.org/),
|
If you _just want a sewing pattern created for you,_
|
||||||
|
you can get all our designs on [FreeSewing.org](https://freesewing.org/),
|
||||||
our website for makers.
|
our website for makers.
|
||||||
|
|
||||||
</Tip>
|
</Tip>
|
||||||
|
|
||||||
## High level overview
|
## High level overview
|
||||||
|
|
||||||
|
@ -58,7 +59,7 @@ Below is a complete example.
|
||||||
<script type="module">
|
<script type="module">
|
||||||
import Aaron from 'https://cdn.skypack.dev/@freesewing/aaron';
|
import Aaron from 'https://cdn.skypack.dev/@freesewing/aaron';
|
||||||
import theme from 'https://cdn.skypack.dev/@freesewing/plugin-theme';
|
import theme from 'https://cdn.skypack.dev/@freesewing/plugin-theme';
|
||||||
const svg = new Aaron({
|
const svg = new Aaron({
|
||||||
sa: 10, // Seam allowance
|
sa: 10, // Seam allowance
|
||||||
paperless: true, // Enable paperless mode
|
paperless: true, // Enable paperless mode
|
||||||
// More settings, see: https://FreeSewing.dev/reference/settings
|
// More settings, see: https://FreeSewing.dev/reference/settings
|
||||||
|
@ -86,7 +87,7 @@ Below is a complete example.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
If you compare this example with [our NodeJS
|
If you compare this example with [our Node.js
|
||||||
example](/howtos/environments/nodejs) you'll notice that you do not
|
example](/howtos/environments/nodejs) you'll notice that you do not
|
||||||
need to worry about loading any dependencies. Not even `@freesewing/core`
|
need to worry about loading any dependencies. Not even `@freesewing/core`
|
||||||
is loaded, because Skypack will pull in all dependencies for you.
|
is loaded, because Skypack will pull in all dependencies for you.
|
||||||
|
|
|
@ -3,3 +3,5 @@ title: FreeSewing in different environments
|
||||||
---
|
---
|
||||||
|
|
||||||
You can use FreeSewing a different environments:
|
You can use FreeSewing a different environments:
|
||||||
|
|
||||||
|
<ReadMore />
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
---
|
---
|
||||||
title: FreeSewing in NodeJS
|
title: FreeSewing in Node.js
|
||||||
---
|
---
|
||||||
|
|
||||||
These instructions explain how you can generate patterns in NodeJS.
|
These instructions explain how you can generate patterns in Node.js.
|
||||||
Whether it's in a backend application or on the command line, all
|
Whether it's in a backend application or on the command line, all
|
||||||
it takes is a few lines of code — and a couple of dependencies — to
|
it takes is a few lines of code — and a couple of dependencies — to
|
||||||
generate a pattern.
|
generate a pattern.
|
||||||
|
@ -12,11 +12,12 @@ generate a pattern.
|
||||||
##### Use FreeSewing.org if you just want a pattern
|
##### Use FreeSewing.org if you just want a pattern
|
||||||
|
|
||||||
These instructions are intended for people who want to generate
|
These instructions are intended for people who want to generate
|
||||||
their own patterns. If you _just want a sewing pattern_ you can
|
their own patterns using FreeSewing packages.
|
||||||
get all our designs on [FreeSewing.org](https://FreeSewing.org/),
|
If you _just want a sewing pattern created for you,_
|
||||||
|
you can get all our designs on [FreeSewing.org](https://freesewing.org/),
|
||||||
our website for makers.
|
our website for makers.
|
||||||
|
|
||||||
</Tip>
|
</Tip>
|
||||||
|
|
||||||
## High level overview
|
## High level overview
|
||||||
|
|
||||||
|
@ -40,7 +41,7 @@ import theme from '@freesewing/plugin-theme' // SVG theme
|
||||||
const svg = new Aaron( // Instantiate pattern
|
const svg = new Aaron( // Instantiate pattern
|
||||||
{ // Pass in settings. See reference > core > settings
|
{ // Pass in settings. See reference > core > settings
|
||||||
sa: 10, // Seam allowance
|
sa: 10, // Seam allowance
|
||||||
// ...
|
// ...
|
||||||
measurements: { // Pass in measurements
|
measurements: { // Pass in measurements
|
||||||
biceps: 387,
|
biceps: 387,
|
||||||
chest: 1105,
|
chest: 1105,
|
||||||
|
@ -75,7 +76,7 @@ console.log(svg)
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
The code above will only work if you've got the required dependencies installed on your system.
|
The code above will only work if you've got the required dependencies installed on your system.
|
||||||
Obviously you need NodeJS, but you will also need the following packages:
|
Obviously you need Node.js, but you will also need the following packages:
|
||||||
|
|
||||||
- `@freesewing/core`: Our core library
|
- `@freesewing/core`: Our core library
|
||||||
- `@freesewing/plugin-bundle`: Set of common plugins
|
- `@freesewing/plugin-bundle`: Set of common plugins
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue