@preply/ds-docs-context
Advanced tools
> DS Providers for documentation pages.
Weekly downloads
Readme
@preply/ds-docs-context
DS Providers for documentation pages.
Follow the instructions in @preply/ds-workspace.
The following components are used to wrap Storybook stories or MDX doc pages, injecting global styles, and the DS providers populated with available themes.
import { DocContextDSWeb } from '@preply/ds-docs-context';
<Meta
title="components/Avatar/Docs"
parameters={{
docs: { container: DocContextDSWeb },
}}
/>;
In pages where you want to render the RootProvider yourself, include DocContext
instead.
import { DocContext } from '@preply/ds-docs-context';
import { StoryContextDSWeb } from '@preply/ds-docs-context';
export default {
title: 'components/Avatar',
component: Avatar,
decorators: [story => <StoryContextDSWeb>{story()}</StoryContextDSWeb>],
// ...
};
export const Canvas: Story<Props> = params => <Component {...params} />;
Execute yarn dev
in @preply/ds-docs to launch the docs.
If you are iterating on these components, you might want to run yarn dev
and yarn docs
in the root (in separate terminals) as per instructions in @preply/ds-workspace.
Details about tools and configurations in @preply/ds-workspace.
@preply/ds-web-core
- Web support and context providers (React + CSS modules).@preply/ds-core
- Platform agnostic types, tokens and utils.@preply/ds-core-types
- Platform agnostic types.FAQs
> DS Providers for documentation pages.
The npm package @preply/ds-docs-context receives a total of 401 weekly downloads. As such, @preply/ds-docs-context popularity was classified as not popular.
We found that @preply/ds-docs-context demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.