Skip to content

Commit 56df7fc

Browse files
authored
Update README
Mention react-notion-x 🀝 @transitive-bullshit
1 parent dddd672 commit 56df7fc

File tree

1 file changed

+29
-23
lines changed

1 file changed

+29
-23
lines changed

β€ŽREADME.md

+29-23
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ _This package doesn't handle the communication with the API. Check out [notion-a
1111

1212
<sub>Created by <a href="https://twitter.com/timolins">Timo Lins</a> & <a href="https://twitter.com/linstobias">Tobias Lins</a> with the help of all <a href="https://github.com/splitbee/react-notion/graphs/contributors">contributors</a> ❀️</sub>
1313

14+
15+
1416
## Features
1517

1618
⚑️ **Fast** – Up to 10x faster than Notion\*
@@ -23,6 +25,10 @@ _This package doesn't handle the communication with the API. Check out [notion-a
2325

2426
_\* First Meaningful Paint compared to a [hosted example](http://react-notion-example.now.sh/) on [Vercel](https://vercel.com)._
2527

28+
29+
**react-notion** is best suited as minimal renderer for blogs & content pages. If you're looking for a full-featured solution to render Notion-like pages, check out [react-notion-x](https://github.com/NotionX/react-notion-x).
30+
31+
2632
## Install
2733

2834
```bash
@@ -96,29 +102,29 @@ List of pages that implement this library.
96102

97103
Most common block types are supported. We happily accept pull requests to add support for the missing blocks.
98104

99-
| Block Type | Supported | Notes |
100-
| ----------------- | ---------- | ---------------------- |
101-
| Text | βœ… Yes | |
102-
| Heading | βœ… Yes | |
103-
| Image | βœ… Yes | |
104-
| Image Caption | βœ… Yes | |
105-
| Bulleted List | βœ… Yes | |
106-
| Numbered List | βœ… Yes | |
107-
| Quote | βœ… Yes | |
108-
| Callout | βœ… Yes | |
109-
| Column | βœ… Yes | |
110-
| iframe | βœ… Yes | |
111-
| Video | βœ… Yes | Only embedded videos |
112-
| Divider | βœ… Yes | |
113-
| Link | βœ… Yes | |
114-
| Code | βœ… Yes | |
115-
| Web Bookmark | βœ… Yes | |
116-
| Toggle List | βœ… Yes | |
117-
| Page Links | βœ… Yes | |
118-
| Header | βœ… Yes | Enable with `fullPage` |
119-
| Databases | ❌ Missing | |
120-
| Checkbox | ❌ Missing | |
121-
| Table Of Contents | ❌ Missing | |
105+
| Block Type | Supported | Notes |
106+
| ----------------- | ---------- | ------------------------------------------------------------------------------------- |
107+
| Text | βœ… Yes | |
108+
| Heading | βœ… Yes | |
109+
| Image | βœ… Yes | |
110+
| Image Caption | βœ… Yes | |
111+
| Bulleted List | βœ… Yes | |
112+
| Numbered List | βœ… Yes | |
113+
| Quote | βœ… Yes | |
114+
| Callout | βœ… Yes | |
115+
| Column | βœ… Yes | |
116+
| iframe | βœ… Yes | |
117+
| Video | βœ… Yes | Only embedded videos |
118+
| Divider | βœ… Yes | |
119+
| Link | βœ… Yes | |
120+
| Code | βœ… Yes | |
121+
| Web Bookmark | βœ… Yes | |
122+
| Toggle List | βœ… Yes | |
123+
| Page Links | βœ… Yes | |
124+
| Header | βœ… Yes | Enable with `fullPage` |
125+
| Databases | ❌ Missing | Not planned. Supported by [react-notion-x](https://github.com/NotionX/react-notion-x) |
126+
| Checkbox | ❌ Missing | Supported by [react-notion-x](https://github.com/NotionX/react-notion-x) |
127+
| Table Of Contents | ❌ Missing | Supported by [react-notion-x](https://github.com/NotionX/react-notion-x) |
122128

123129
## Block Type Specific Caveats
124130

0 commit comments

Comments
Β (0)