@preply-ds/docs-toolkit v0.4.2

@preply-ds/docs-toolkit

Components and helpers for stories and doc pages.

Used in MDX pages:

• @preply-ds/docs-pages
• @preply-ds/web-lib

Also used by @preply-ds/docs-context.

WIP: Install in @preply/shared to replace the legacy one in common/.

Using the Design System in your application or library?

Follow the instructions in @preply-ds/workspace.

Tooling

Documentation entry point is in @preply-ds/docs.

Details about tools and configurations in @preply-ds/workspace.

Development

• classes/ model the instrumentation data and metadata collected by fe-tools
• components/ can be used in any MDX file to:
  • render prop option tables, component metadata, ...
  • decorate examples with lorem ipsum, placeholders, ...
• providers/ and hooks/ to use metadata context MDX files (used by ds-docs DocContext)

Dependencies

We want to preserve portability of these components in case we want to used them in a non-storybook environment.

Do NOT add dependencies on:

• anything Storybook
• anything Preply