Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hyf0/notion-renderer
Renderer for notion using Official Notion API
https://github.com/hyf0/notion-renderer
notion
Last synced: 2 months ago
JSON representation
Renderer for notion using Official Notion API
- Host: GitHub
- URL: https://github.com/hyf0/notion-renderer
- Owner: hyf0
- License: mit
- Created: 2022-02-18T14:01:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-28T13:13:23.000Z (over 2 years ago)
- Last Synced: 2023-03-10T17:47:43.776Z (almost 2 years ago)
- Topics: notion
- Language: TypeScript
- Homepage: http://notion-renderer.ihyf.me/
- Size: 399 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# notion-renderer
Renderer for notion using Official Notion API.
[Vercel Preview](http://notion-renderer.ihyf.me/)
# Features
- Official Notion API
- Atomic CSS
## Supported Blocks
- ✅ Fully supported
- ⚠️ Partially supported
- ❌ WIP
| Block Type | Supported | Block Type Enum |
| ------------------------ | --------- | ---------------------- |
| Page | ⚠️ | `page` |
| Text | ⚠️ | `text` |
| Bookmark | ⚠️ | `bookmark` |
| Bulleted List | ⚠️ | `bulleted_list` |
| Numbered List | ✅ | `numbered_list` |
| Heading 1 | ✅ | `header` |
| Heading 2 | ✅ | `sub_header` |
| Heading 3 | ✅ | `sub_sub_header` |
| Quote | ✅ | `quote` |
| Callout | ⚠️ | `callout` |
| Equation (block) | ❌ | `equation` |
| Equation (inline) | ❌ | `text` |
| Todos (checkboxes) | ✅ | `to_do` |
| Table Of Contents | ✅ | `table_of_contents` |
| Divider | ✅ | `divider` |
| Column | ✅ | `column` |
| Column List | ⚠️ | `column_list` |
| Toggle | ⚠️ | `toggle` |
| Image | ⚠️ | `image` |
| Embed | ❌ | `embed` |
| Video | ❌ | `video` |
| Figma | ❌ | `figma` |
| Google Maps | ❌ | `maps` |
| Google Drive | ❌ | `drive` |
| Tweet | ❌ | `tweet` |
| PDF | ❌ | `pdf` |
| Audio | ❌ | `audio` |
| File | ❌ | `file` |
| Link | ⚠️ | `text` |
| Page Link | ⚠️ | `page` |
| External Page Link | ⚠️ | `text` |
| Code (block) | ⚠️ | `code` |
| Code (inline) | ✅ | `text` |
| Collections | ❌ | |
| Collection View | ❌ | `collection_view` |
| Collection View Table | ❌ | `collection_view` |
| Collection View Gallery | ❌ | `collection_view` |
| Collection View Board | ❌ | `collection_view` |
| Collection View List | ❌ | `collection_view` |
| Collection View Calendar | ❌ | `collection_view` |
| Collection View Page | ❌ | `collection_view_page` |
# Packages
- @notion-renderer/react
- @notion-renderer/vue(WIP)
- @notion-renderer/client
- @notion-renderer/shared
# Related projects
- [Quipu](https://github.com/iheyunfei/quipu)