Skip to content

Commit e0ca560

Browse files
1 parent 1b65b28 commit e0ca560

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

packages/notion-compat/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@ You can preview `react-notion-x` using the official client and compatibility lay
3232

3333
## Status
3434

35-
Many blocks aren't displayed properly (sometimes in subtle ways) because Notion's official API doesn't contain enough formatting info for us to faithfully render content, so I recommend checking out [the notion-compat demo](https://react-notion-x-official-api-demo.transitivebullsh.it/) side-by-side with the [normal react-notion-x demo](https://react-notion-x-demo.transitivebullsh.it/) (which uses the unofficial Notion API via `notion-client`) and/or the [equivalent public notion page](https://transitive-bs.notion.site/Notion-Kit-Test-Suite-067dd719a912471ea9a3ac10710e7fdf).
35+
The main feature missing from `notion-compat` right now is collection (database) support.
3636

37-
The main thing feature from `notion-compat` right now feature-wise is collection (database) support.
37+
Many blocks aren't displayed properly (sometimes in subtle ways) because Notion's official API doesn't contain enough formatting info for us to faithfully render blocks in all cases. See the block-by-block compatibility notes below for more info.
38+
39+
I recommend checking out [the notion-compat demo](https://react-notion-x-official-api-demo.transitivebullsh.it/) side-by-side with the [normal react-notion-x demo](https://react-notion-x-demo.transitivebullsh.it/) (which uses the unofficial Notion API via `notion-client`) and the [equivalent public notion page](https://transitive-bs.notion.site/Notion-Kit-Test-Suite-067dd719a912471ea9a3ac10710e7fdf).
3840

3941
Note that using the official API with `notion-compat` is quite a bit slower than using the unofficial API via `notion-client` because of [reasons](https://github.com/NotionX/react-notion-x/issues/269#issuecomment-1100648873).
4042

0 commit comments

Comments
 (0)