ataztech910 / notion-to-html

This is the library to convert API response from Notion to html for saving or server rendering

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NOTION TO HTML LIBRARY

*** This package is in alpha version please use it in your own risk This library is created to convert Notion API block response into the HTML code that can be used for the server rendering

to use the libraray please follow the instructions

  1. install the package using npm i notion-to-html command
  2. Then in your code import it using the code import { NotionToHtml } from "notion-to-html";
  3. Use the library in your code like this const html = NotionToHtml(<YOUR-API-RESPONSE>, true);

At the current state we have following eleemnts covered:

  • Bookmark - done βœ…
  • Breadcrumb - will not be done 🚫
  • Bulleted list item - done βœ…
  • Callout - done βœ…
  • Child database - will not be done 🚫
  • Child page - will not be done 🚫
  • Code - done βœ…
  • Column list and column - will not be done 🚫
  • Divider - done βœ…
  • Embed - as its requires third party software or same solution it will be moved to after-release stage ⌚
  • Equation - it will be moved to after-release stage ⌚
  • File - done βœ…
  • Headings - done βœ…
  • Image - done βœ…
  • Link Preview - will not be done 🚫
  • Mention - will not be done 🚫
  • Numbered list item - done βœ…
  • Paragraph - done βœ…
  • PDF - done βœ…
  • Quote - done βœ…
  • Synced block - it will be moved to after-release stage ⌚
  • Table - it will be moved to after-release stage ⌚
  • Table of contents - it will be moved to after-release stage ⌚
  • Template - will not be done 🚫
  • To do - done βœ…
  • Toggle blocks - it will be moved to after-release stage ⌚
  • Video - it will be moved to after-release stage ⌚ (same as embed element)

About

This is the library to convert API response from Notion to html for saving or server rendering


Languages

Language:TypeScript 100.0%