Skip to content

Commit

Permalink
docs: add information about peer dependencies, and fix broken link on…
Browse files Browse the repository at this point in the history
… storybook (#605)
  • Loading branch information
niktverd authored Sep 28, 2023
1 parent f6b95f5 commit c5c7893
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@

When creating pages, component-based approach is used: a page is built using a set of ready-made blocks that can be placed in any order. Each block has a certain type and set of input data parameters.

For the format of input data and list of available blocks, see the [documentation](https://preview.yandexcloud.dev/page-constructor/?path=/story/information--blocks).
For the format of input data and list of available blocks, see the [documentation](https://preview.yandexcloud.dev/page-constructor/?path=/docs/documentation-blocks--docs).

## Install

```shell
npm install @gravity-ui/page-constructor
```

## Required dependencies

Please note that to start using the package, your project must also have the following installed: `@doc-tools/transform`, `@gravity-ui/uikit`, `react`. Check out the `peerDependencies` section of `package.json` for accurate information.

### Getting started

The page constructor is imported as a React component. To make sure it runs properly, wrap it in `PageConstructorProvider`:
Expand Down

0 comments on commit c5c7893

Please sign in to comment.