VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Update option docs

Browse source
This commit is contained in:
Joost De Cock 2022-02-05 17:44:23 +01:00
parent d0e05fe455
commit 52ddbaaa02
28 changed files with 952 additions and 631 deletions
Download patch file Download diff file Expand all files Collapse all files

22
markdown/dev/reference/api/config/hide/en.md
View file

@ -2,14 +2,26 @@
title: hide
---
The `hide` key in the pattern configuration file allow you to configure
parts the should be hidden by default.
*Hidden* means that they will be drafted, but not rendered. This is
ypically used for a base part on which other parts are built.
Note that hidden parts will be rendered when the user requests
to [only draft some parts of a pattern](/reference/api/settings/only)
and includes the hidden part(s).
## Structure
An array with strings that hold part names.
## Example
```js
hide: [
"base"
]
```
An array that lists pattern parts that should be hidden by default.
Hidden means that they will be drafted, but not rendered. Typically used
for a base part on which other parts are built.
In the configuration above, the `base` part will be hidden by default.