Revert "chore: Linting for markdown and js"
This reverts commit 1c92e0f655
.
This commit is contained in:
parent
994874fa72
commit
cba1ab19c8
6627 changed files with 25791 additions and 24211 deletions
|
@ -1,17 +1,17 @@
|
|||
***
|
||||
---
|
||||
title: Blockquote
|
||||
---
|
||||
|
||||
## title: Blockquote
|
||||
|
||||
The `Blockquote` component is a base blockquote that can be styled
|
||||
The `Blockquote` component is a base blockquote that can be styled
|
||||
in a number of different ways via the `type` prop which can be set to:
|
||||
|
||||
* note
|
||||
* warning
|
||||
* tip
|
||||
* fixme
|
||||
|
||||
- note
|
||||
- warning
|
||||
- tip
|
||||
- fixme
|
||||
|
||||
It is typically used in our MDX content where we make the `Note`, `Warning`,
|
||||
`Tip` and `Fixme` components available in the global scope. They all use
|
||||
`Tip` and `Fixme` components available in the global scope. They all use
|
||||
the `Blockquote` component under the hood.
|
||||
|
||||
## Examples
|
||||
|
@ -28,6 +28,7 @@ the `Blockquote` component under the hood.
|
|||
<Blockquote type='note'> This is a note </Blockquote>
|
||||
```
|
||||
|
||||
|
||||
### Type: tip
|
||||
|
||||
<Tip> This is a tip </Tip>
|
||||
|
@ -40,6 +41,7 @@ the `Blockquote` component under the hood.
|
|||
<Blockquote type='tip'> This is a tip </Blockquote>
|
||||
```
|
||||
|
||||
|
||||
### Type: warning
|
||||
|
||||
<Warning> This is a warning </Warning>
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
***
|
||||
|
||||
## title: Draft
|
||||
---
|
||||
title: Draft
|
||||
---
|
||||
|
||||
The `Draft` component renders a FreeSewing pattern in the browser as SVG.
|
||||
|
||||
To use the `Draft` component, pass it the result of `pattern.getRenderProps()`
|
||||
as props:
|
||||
|
||||
```js
|
||||
```js
|
||||
const renderProps = pattern.draft().getRenderProps()
|
||||
|
||||
return <Draft {...renderProps} />
|
||||
|
@ -21,12 +21,13 @@ The `pattern.getRenderProps()` returns a range of props, including
|
|||
an SVG object on which the `preRender` hook gets called prior to
|
||||
returning.
|
||||
|
||||
This way, svg.defs now holds all defs, including any that may have
|
||||
been added by custom plugins, and we use this verbatim in our
|
||||
This way, svg.defs now holds all defs, including any that may have
|
||||
been added by custom plugins, and we use this verbatim in our
|
||||
React component.
|
||||
|
||||
This removes any discrepancies in how SVG rendering and React
|
||||
rendering handles the defs section of the SVG document,
|
||||
This removes any discrepancies in how SVG rendering and React
|
||||
rendering handles the defs section of the SVG document,
|
||||
and thus displays snippets.
|
||||
|
||||
</Note>
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: DraftConfigurator
|
||||
---
|
||||
title: DraftConfigurator
|
||||
---
|
||||
|
||||
The `DraftConfigurator` provides the user interface for configuring a draft.
|
||||
It is a rather complex component, that is used both for the freesewing.org website
|
||||
|
@ -11,3 +11,5 @@ as for our development environment.
|
|||
## Example
|
||||
|
||||

|
||||
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Emblem
|
||||
---
|
||||
title: Emblem
|
||||
---
|
||||
|
||||
The `Emblem` component renders the freesewing word in the top-left of our navigation bar.
|
||||
|
||||
|
@ -9,3 +9,4 @@ The `Emblem` component renders the freesewing word in the top-left of our naviga
|
|||
## Example
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: "@freesewing/components"
|
||||
---
|
||||
title: "@freesewing/components"
|
||||
---
|
||||
|
||||
This is a collection for React components for FreeSewing's websites:
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Example
|
||||
---
|
||||
title: Example
|
||||
---
|
||||
|
||||
The `Example` component renders the [examples](/reference/packages/examples/) pattern.
|
||||
It is used throughout our developer documentation.
|
||||
|
@ -10,3 +10,4 @@ It is used throughout our developer documentation.
|
|||
## Example
|
||||
|
||||
<Example part="path_intersects" caption="The Example component used to illustrate the Path.intersects() method" />
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Footer
|
||||
---
|
||||
title: Footer
|
||||
---
|
||||
|
||||
The `Footer` component is the shared footer we use on our websites.
|
||||
|
||||
|
@ -9,3 +9,4 @@ The `Footer` component is the shared footer we use on our websites.
|
|||
## Example
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
***
|
||||
---
|
||||
title: Icon
|
||||
---
|
||||
|
||||
## title: Icon
|
||||
|
||||
The `Icon` component renders a couple of icons that we use, but
|
||||
The `Icon` component renders a couple of icons that we use, but
|
||||
are not available in the standard [material icon set](https://material.io/resources/icons/).
|
||||
|
||||
<Fixme> Add more documentation for this component </Fixme>
|
||||
|
@ -20,3 +20,4 @@ are not available in the standard [material icon set](https://material.io/resour
|
|||
| `note` | <svg class="" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path stroke="none" fill="currentColor" d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm1 15h-2v-6h2v6zm0-8h-2V7h2v2z" ></path></svg> |
|
||||
| `tip` | <svg class="" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path stroke="none" fill="currentColor" d="M12 17.27L18.18 21l-1.64-7.03L22 9.24l-7.19-.61L12 2 9.19 8.63 2 9.24l5.46 4.73L5.82 21z" ></path></svg> |
|
||||
| `warning` | <svg class="" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path stroke="none" fill="currentColor" d="M1 21h22L12 2 1 21zm12-3h-2v-2h2v2zm0-4h-2v-4h2v4z" ></path></svg> |
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Linedrawing
|
||||
---
|
||||
title: Linedrawing
|
||||
---
|
||||
|
||||
The `Linedrawing` component renders linedrawings for the FreeSewing patterns.
|
||||
|
||||
|
@ -9,3 +9,4 @@ The `Linedrawing` component renders linedrawings for the FreeSewing patterns.
|
|||
## Example
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Logo
|
||||
---
|
||||
title: Logo
|
||||
---
|
||||
|
||||
The `Logo` component renders the FreeSewing logo.
|
||||
|
||||
|
@ -9,3 +9,4 @@ The `Logo` component renders the FreeSewing logo.
|
|||
## Example
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Navbar
|
||||
---
|
||||
title: Navbar
|
||||
---
|
||||
|
||||
The `Navbar` component is the shared navigation bar we use at the top of our websites.
|
||||
|
||||
|
@ -9,3 +9,4 @@ The `Navbar` component is the shared navigation bar we use at the top of our web
|
|||
## Example
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Render
|
||||
---
|
||||
title: Render
|
||||
---
|
||||
|
||||
The `Render` component is componet that renders a FreeSewing pattern.
|
||||
It's an alternative to rendering patterns as SVG, allowing for more
|
||||
|
@ -34,11 +34,11 @@ The name `Draft` is deprecated and will be removed in a future release.
|
|||
|
||||
<Note>
|
||||
|
||||
###### (\*) Use `pattern.getRenderProps()` to get these props
|
||||
###### (*) Use `pattern.getRenderProps()` to get these props
|
||||
|
||||
The `width`, `height`, `settings`, and `parts` props are provided by the
|
||||
[getRenderProps()](/reference/api/pattern/#getrenderprops) method of
|
||||
the [Pattern](/reference/api/pattern/) object.
|
||||
The `width`, `height`, `settings`, and `parts` props are provided by the
|
||||
[getRenderProps()](/reference/api/pattern/#getrenderprops) method of
|
||||
the [Pattern](/reference/api/pattern/) object.
|
||||
|
||||
They are typically uses as in the example below:
|
||||
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: SampleConfigurator
|
||||
---
|
||||
title: SampleConfigurator
|
||||
---
|
||||
|
||||
The `SampleConfigurator` provides the user interface for configuring sampling of a pattern.
|
||||
It is used in our development environment.
|
||||
|
@ -10,3 +10,5 @@ It is used in our development environment.
|
|||
## Example
|
||||
|
||||
<Fixme> Add screenshot </Fixme>
|
||||
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Spinner
|
||||
---
|
||||
title: Spinner
|
||||
---
|
||||
|
||||
The `Spinner` component renders a loading indicator with the FreeSewing logo.
|
||||
|
||||
|
@ -11,3 +11,4 @@ It is a pure SVG implementation, using SMIL for animation.
|
|||
## Example
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
***
|
||||
|
||||
## title: WithGist
|
||||
---
|
||||
title: WithGist
|
||||
---
|
||||
|
||||
The `WithGist` component is a higher order component that adds management of a `gist`
|
||||
to your component. A gist is almost the same as a recipe, that is, it stores all the data
|
||||
required to draft your pattern.
|
||||
|
||||
This component is used under the hood in both the freesewing.org website as our
|
||||
This component is used under the hood in both the freesewing.org website as our
|
||||
development environment.
|
||||
|
||||
|
|
|
@ -1,9 +1,10 @@
|
|||
***
|
||||
|
||||
## title: WithLanguage
|
||||
---
|
||||
title: WithLanguage
|
||||
---
|
||||
|
||||
The `WithLanguage` component is a higher order component that is used to inject
|
||||
the [react-intl](https://github.com/formatjs/react-intl) context into your component.
|
||||
|
||||
This component is used under the hood in both the freesewing.org website as our
|
||||
This component is used under the hood in both the freesewing.org website as our
|
||||
development environment.
|
||||
|
||||
|
|
|
@ -1,9 +1,10 @@
|
|||
***
|
||||
|
||||
## title: WithStorage
|
||||
---
|
||||
title: WithStorage
|
||||
---
|
||||
|
||||
The `WithStorage` component is a higher order component that adds saving to and reading from
|
||||
(the browser's) local storage to your component.
|
||||
|
||||
This component is used under the hood in both the freesewing.org website as our
|
||||
This component is used under the hood in both the freesewing.org website as our
|
||||
development environment.
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
***
|
||||
|
||||
## title: Workbench
|
||||
---
|
||||
title: Workbench
|
||||
---
|
||||
|
||||
The `Workbench` component provides the FreeSewing development environment.
|
||||
It is a rather complex component, that is used as the entrypoint component
|
||||
|
@ -11,3 +11,5 @@ for our development environment.
|
|||
## Example
|
||||
|
||||

|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue