1
0
Fork 0

[react] feat: Added docs for components/DiffViewer

This commit is contained in:
joostdecock 2025-05-10 14:48:08 +02:00
parent e47d03cdb2
commit a5f4dfa6a3
2 changed files with 24 additions and 9 deletions

View file

@ -2,6 +2,28 @@
title: DiffViewer
---
:::note
This page is yet to be created
import { DocusaurusDoc } from '@freesewing/react/components/Docusaurus'
<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]
:::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].
:::
</DocusaurusDoc>
[dv]: https://github.com/aeolun/react-diff-viewer-continued?tab=readme-ov-file#usage
[jsd]: https://github.com/kpdecker/jsdiff