From a5f4dfa6a32eb961c4effc996b106a1cc4cc9202 Mon Sep 17 00:00:00 2001 From: joostdecock Date: Sat, 10 May 2025 14:48:08 +0200 Subject: [PATCH] [react] feat: Added docs for components/DiffViewer --- .../react/components/design/readme.mdx | 7 ----- .../react/components/diffviewer/readme.mdx | 26 +++++++++++++++++-- 2 files changed, 24 insertions(+), 9 deletions(-) delete mode 100644 sites/dev/docs/reference/packages/react/components/design/readme.mdx diff --git a/sites/dev/docs/reference/packages/react/components/design/readme.mdx b/sites/dev/docs/reference/packages/react/components/design/readme.mdx deleted file mode 100644 index b511c5dd866..00000000000 --- a/sites/dev/docs/reference/packages/react/components/design/readme.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Design ---- - -:::note -This page is yet to be created -::: diff --git a/sites/dev/docs/reference/packages/react/components/diffviewer/readme.mdx b/sites/dev/docs/reference/packages/react/components/diffviewer/readme.mdx index e1a706ca063..06c89006715 100644 --- a/sites/dev/docs/reference/packages/react/components/diffviewer/readme.mdx +++ b/sites/dev/docs/reference/packages/react/components/diffviewer/readme.mdx @@ -2,6 +2,28 @@ title: DiffViewer --- -:::note -This page is yet to be created +import { DocusaurusDoc } from '@freesewing/react/components/Docusaurus' + + + +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 @freesewing/react package for convenience. + +Please refer to the documentation for [react-diff-viewer-continued][dv] and [jsdiff][jsd]. ::: + + + +[dv]: https://github.com/aeolun/react-diff-viewer-continued?tab=readme-ov-file#usage +[jsd]: https://github.com/kpdecker/jsdiff