DS Docs (main pages)
Documentation pages (welcome, themes, ...)
Using the Design System in your application or library?
Follow the instructions in @preply-ds/workspace.
Development
Execute yarn docs
in @preply-ds/docs to launch the docs.
If you are iterating on these docs, you might want to run yarn docs
in the root, as per instructions in @preply-ds/workspace.
Which documentation is included in this package?
- Welcome pages
- Assets
- Themes & Color Scheme
WIP: Guides (dev): installation, for library maintainers, for application maintainers, for contributors
Tooling
Documentation entry point is in @preply-ds/docs.
Details about tools and configurations in @preply-ds/workspace.
Dependencies
This package should depend only on:
-
@preply-ds/docs-context
DS Provider -
@preply-ds/docs-toolkit
components for MDX files README storybook -
@storybook/***
and Webpack loaders
Do NOT add dependencies on Preply component libraries, especially DS packages like ds-core
, ds-web-lib
, ...