1
0
Fork 0

feat(dev): Added react docs for Pattern + refactor

This adds support for not only documenating components, but also
constants and functions that may be exported next to components.
This commit is contained in:
joostdecock 2025-05-25 16:29:57 +02:00
parent d0baf7cece
commit 22a89f12d3
50 changed files with 1816 additions and 669 deletions

View file

@ -3,26 +3,45 @@ title: DiffViewer
---
import { DocusaurusDoc } from '@freesewing/react/components/Docusaurus'
import { FunctionDocs } from '@site/src/components/function-docs.js'
import * as fndoc from '@site/prebuild/jsdoc/functions.diffviewer.mjs'
<DocusaurusDoc>
The **DiffViewer** component family provides the following components:
- [DiffViewer](#diffviewer): A re-export of [react-diff-viewer-continued][dv]
In addition, it also exports the following functions:
- [diffJSON](#diffjson): A re-export of the [diffJson][jsd] function of the [jsdiff package][jsd]
- [diffCheck](#diffcheck): A re-export of the [diffWords][jsd] function of the [jsdiff package][jsd]
- [Components](#components)
- [Functions](#functions)
:::tip
#### Not FreeSewing code
This component family only contains re-exports of code by other maintainers.\
Since they are a dependency, we provide them as part of the <code>@freesewing/react</code> package for convenience.
Please refer to the documentation for [react-diff-viewer-continued][dv] and [jsdiff][jsd].
:::
## Components
The **DiffViewer** component family provides the following components:
- [DiffViewer](#diffviewer): A re-export of [react-diff-viewer-continued][dv]
## Functions
The **DiffViewer** family also exports the following functions:
- [diffJSON](#diffjson): A re-export of the [diffJson][jsd] function of the [jsdiff package][jsd]
- [diffCheck](#diffcheck): A re-export of the [diffWords][jsd] function of the [jsdiff package][jsd]
### diffJSON
<FunctionDocs docs={fndoc.jsdocdiffJSON} />
### diffCheck
<FunctionDocs docs={fndoc.jsdocdiffCheck} />
</DocusaurusDoc>
[dv]: https://github.com/aeolun/react-diff-viewer-continued?tab=readme-ov-file#usage