An unofficial Notion renderer (Vue 3) version
A Vue 3 renderer for Notion pages (ported from vue-notion). Special thanks to Jannik Siebert & all the vue-notion
contributors that made the vue-notion
possible!
Use Notion as CMS for your blog, documentation or personal site. Also check out react-notion (developed by Splitbee ๐ โ a fast, reliable, free, and modern analytics for any team)
This package doesn't handle the communication with the API (I planned to add this!). Check out notion-api-worker from Splitbee for an easy solution.
Created by Zernonia
๐ SSR / Static Generation Support โ Functions to work with Nuxt3 and other frameworks
๐ฏ Accurate โ Results are almost identical
๐จ Custom Styles โ Styles are easily adaptable. Optional styles included
๐ฎ Syntax-Highlighting โ Beautiful themeable code highlighting using Prism.js
npm install vue3-notion
# yarn add vue3-notion
Install as a dev-dependency and add "vue3-notion/nuxt"
to the buildModules
array in nuxt.config.js
.
npm install vue3-notion --save-dev
// nuxt.config.ts
import { defineNuxtConfig } from "nuxt3"
export default defineNuxtConfig({
//...
modules: [
["vue3-notion/nuxt", { css: true }], // css is not imported by default. Set `true` to import css
],
})
These examples use a simple wrapper around the notion-api-worker
to access the Notion page data.
It is also possible to store a page received from the Notion API in .json
and use it without the async/await
part.
Use the
getPageBlocks
andgetPageTable
methods with caution! They are based on the private Notion API. We can NOT guarantee that it will stay stable. The private API is warpped by notion-api-worker.
This example is a part of demo/
and is hosted at vue3-notion.vercel.app.
<script setup lang="ts">
import { NotionRenderer, getPageBlocks, useGetPageBlocks } from "vue3-notion"
import { ref, onMounted } from "vue"
const data = ref()
onMounted(async () => {
data.value = await getPageBlocks("4b2dc28a5df74034a943f8c8e639066a")
})
// ---- or using Composables ----
const { data } = useGetPageBlocks("4b2dc28a5df74034a943f8c8e639066a")
</script>
<template>
<NotionRenderer v-if="data" :blockMap="data" fullPage />
</template>
<style>
@import "vue3-notion/dist/style.css"; /* optional Notion-like styles */
@import "prismjs/themes/prism.css";
@import "katex/dist/katex.min.css";
</style>
This example is a part of demo/
and is hosted at vue3-notion.vercel.app.
<script setup lang="ts">
const { $notion } = useNuxtApp()
const { data } = await useAsyncData("notion", () => $notion.getPageBlocks("2e22de6b770e4166be301490f6ffd420"))
</script>
<template>
<NotionRenderer :blockMap="data" fullPage prism />
</template>
Most common block types are supported. We happily accept pull requests to add support for the missing blocks.
Block Type | Supported | Notes |
---|---|---|
Text | โ Yes | |
Heading | โ Yes | |
Image | โ Yes | |
Image Caption | โ Yes | |
Bulleted List | โ Yes | |
Numbered List | โ Yes | |
Quote | โ Yes | |
Callout | โ Yes | |
Column | โ Yes | |
iframe | โ Yes | |
Video | โ Yes | Only embedded videos |
Divider | โ Yes | |
Link | โ Yes | |
Code | โ Yes | |
Web Bookmark | โ Yes | |
Toggle List | โ Yes | |
Page Links | โ Yes | |
Cover | โ Yes | Enable with fullPage |
Equations | โ Yes | |
Checkbox | โ Yes | |
Simple Tables | โ Yes | |
Table Of Contents | โ Yes | |
Databases | โ๏ธ Planned |
Please, feel free to open an issue if you notice any important blocks missing or anything wrong with existing blocks.
Yarn
npm install --global yarn
git clone https://github.com/zernonia/vue3-notion.git
yarn
yarn dev
MIT ยฉ zernonia