VSinerva/freesewing
1
0
Fork 0
Code Activity
freesewing/markdown/dev/reference/api/en.md

89 lines
4.9 KiB
Markdown
Raw Normal View History

Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81.
2021-10-17 18:26:00 +02:00
---
chore(markdown): Changed core API title
2022-10-01 23:05:57 +02:00
title: Core API
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
wip: Working on better developer docs
2021-09-25 17:05:18 +02:00
This is the documentation for FreeSewing's core library, published as `@freesewing/core` on NPM.
chore(markdown): Linting of dev docs
2022-02-19 08:04:25 +01:00
It's a complete toolbox for parametric design with a primary focus on
wip: Working on better developer docs
2021-09-25 17:05:18 +02:00
sewing patterns, but can be utilized for a variety of similar 2D design tasks.
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
<Tip>
wip: Working on better developer docs
2021-09-25 17:05:18 +02:00
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
##### Looking to get started?
wip: Working on better developer docs
2021-09-25 17:05:18 +02:00
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
You are currently browsing the reference documentation.
fix(dev-docs): replace quickstart with tutorial
2022-10-18 18:06:35 +02:00
Please refer to our [tutorials](/tutorials) to get started.
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): Working on v3 docs
2022-09-20 18:09:28 +02:00
</Tip>
wip: Working on better developer docs
2021-09-25 17:05:18 +02:00
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
## Core API Documentation
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
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
<ReadMore recurse />
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
## Named exports
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
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
In general, software published under the FreeSewing namespaces prefers named
exports over default exports, and the `@freesewing/core` package provides several of them.
I have grouped them below in different categories:
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
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
- [Constructors](#constructors)
- [Constants](#constants)
- [Utilities](#utilities)
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
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
### Constructors
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): Working on v3 docs
2022-09-20 18:09:28 +02:00
| Named export | Description |
| ------------ | ------------|
| `Attributes` | The [Attributes](/reference/api/attributes) constructor |
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
| `Design` | The [Design](/reference/api/design) constructor |
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
| `Pattern` | The [Pattern](/reference/api/pattern) constructor |
| `Point` | The [Point](/reference/api/point) constructor |
| `Path` | The [Path](/reference/api/path) constructor |
| `Part` | The [Part](/reference/api/part) constructor |
| `Snippet` | The [Snippet](/reference/api/snippet) constructor |
| `Store` | The [Store](/reference/api/store) constructor |
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
### Constants
| Named export | Description |
| -------------- | ------------|
| `cbqc` | The Cubic Bezier Quarter Circle constant: `0.55191502449351` FIXME: include link |
| `hidePresets` | Presets you can use to [configure your part `hide` option](/reference/api/part/config/hide). |
| `goldenRatio` | The golden ratio constant: `1.618034` FIXME: include link |
| `version` | The version of `@freesewing/core` |
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
### Utilities
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
| Named export | Description |
| ------------ | ------------|
fix(dev-docs): broken links
2022-10-18 18:10:59 +02:00
| `beamIntersectsCircle` | See the [beamIntersectsCircle](/reference/api/utils/beamintersectscircle) documentation |
Documentation
2023-04-28 17:49:19 +00:00
| `beamIntersectsCurve` | See the [beamIntersectsCurve](/reference/api/utils/beamintersectscurve) documentation |
fix(dev-docs): broken links
2022-10-18 18:10:59 +02:00
| `beamIntersectsX` | See the [beamIntersectsX](/reference/api/utils/beamintersectsx) documentation |
| `beamIntersectsY` | See the [beamIntersectsY](/reference/api/utils//beamintersectsy) documentation |
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
| `beamsIntersect` | See the [beamsIntersect](/reference/api/utils/beamsintersect) documentation |
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
| `Bezier` | A re-export of [the bezier-js dependency](https://www.npmjs.com/package/bezier-js) |
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
| `capitalize` | See the [capitalize](/reference/api/utils/capitalize) documentation |
| `circlesIntersect` | See the [circlesIntersect](/reference/api/utils/circlesintersect) documentation |
chore(docs): Add Utils.curveEdge() to API documentation
2022-12-08 12:56:58 -08:00
| `curveEdge` | See the [curveEdge](/reference/api/utils/curveedge) documentation |
fix(dev-docs): broken links
2022-10-18 18:10:59 +02:00
| `curveIntersectsX` | See the [curveIntersectsX](/reference/api/utils/curveintersectsx) documentation |
| `curveIntersectsY` | See the [curveIntersectsY](/reference/api/utils/curveintersectsy) documentation |
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
| `curvesIntersect` | See the [curvesIntersect](/reference/api/utils/curvesintersect) documentation |
| `deg2rad` | See the [deg2rad](/reference/api/utils/deg2rad) documentation |
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
| `generateStackTransform` | See the [generateStackTransform](/reference/api/utils/generatestacktransform) documentation |
| `getTransformedBounds` | See the [getTransformedBounds](/reference/api/utils/gettransformedbounds) documentation |
fix(dev-docs): broken links
2022-10-18 18:10:59 +02:00
| `lineIntersectsCircle` | See the [lineIntersectsCircle](/reference/api/utils/lineintersectscircle) documentation |
| `lineIntersectsCurve` | See the [lineIntersectsCurve](/reference/api/utils/lineintersectscurve) documentation |
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
| `linesIntersect` | See the [linesIntersect](/reference/api/utils/linesintersect) documentation |
feat(markdon): Document missing named exports in core
2023-10-21 13:23:32 +02:00
| `mergeIi18n` | See the [mergeI18n](/reference/api/utils/mergei18n) documentation |
feat(markdown): Docs for utils.mergeOptions()
2023-06-11 15:57:16 +02:00
| `mergeOptions` | See the [mergeOptions](/reference/api/utils/mergeoptions) documentation |
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
| `pctBasedOn` | See the [pctBasedOn](/reference/api/utils/pctbasedon) documentation |
| `pointOnBeam` | See the [pointOnBeam](/reference/api/utils/pointonbeam) documentation |
| `pointOnCurve` | See the [pointOnCurve](/reference/api/utils/pointoncurve) documentation |
| `pointOnLine` | See the [pointOnLine](/reference/api/utils/pointonline) documentation |
| `rad2deg` | See the [rad2deg](/reference/api/utils/rad2deg) documentation |
fix(docs): utils.round() missing from Core API
2022-12-05 19:08:36 -08:00
| `round` | See the [round](/reference/api/utils/round) documentation |
chore(markdown): Working on v3 docs
2022-09-20 18:09:28 +02:00
| `splitCurve` | See the [splitCurve](/reference/api/utils/splitcurve) documentation |
| `stretchToScale` | See the [stretchToScale](/reference/api/utils/stretchtoscale) documentation |
| `units` | See the [units](/reference/api/utils/units) documentation |
Copy permalink