1
0
Fork 0
freesewing/markdown/dev/reference/api/config/en.md
nikhil 0becd057b2 fix: Broken/misleading links to designs' source code
Some of these links were actually broken, since they expect to find designs under the `packages/` directory in the current `develop` branch. Other links were technically okay, since they link to old commits, but updating those links may still help to reduce confusion.

Also fix a reference to `packages/unice` in a `netlify.toml` file. (Untested, but I don't think this is an actual Netlify configuration.)
2022-08-21 12:31:23 -04:00

38 lines
877 B
Markdown

---
title: Pattern configuration file
---
The pattern configuration file holds a variety of information about the
pattern, its various parts, what measurements it requires, the options it
accepts and so on.
It is part of the initial design and as such static in nature.
<Note>
This is about the pattern configuration file, used at build-time.
For run-time configuration, see [Pattern settings](/reference/api/settings).
</Note>
## Structure
The pattern configuration is a plain object with one or more of the following
properties:
<ReadMore />
## Example
Below is a minimal example. Look at [the Aaron config file][aaron] for a full example.
```js
const config = {
version: '0.0.1',
name: "sorcha",
// More configuration here
}
```
[aaron]: https://github.com/freesewing/freesewing/blob/3ca5d0edfe54c7ac20aaf3af2f3544aee72f9b99/designs/aaron/config/index.js