Code Monkey home page Code Monkey logo

notion-headless-cms's Introduction

Notion Headles CMS

From Notion to the static website


๐Ÿ“– Table of Contents


๐Ÿ“ Overview

Notion API library focused on retrieve database pages as a Headless CMS (like Strapi, Storyblok, Sanity ...) In addition to API calls, process some Notion content blocks for an easily rendering with whatever tech stack you want


๐Ÿ“ฆ Features

  • Simple methods for list pages metadata, retrieve page metadata with content, or recover all pages with its content
  • Works with both public and private Notion content
  • Example script available which shows how to export Notion content to json file

๐Ÿ“‚ Repository Structure

โ””โ”€โ”€ notion-headless-cms/
    โ”œโ”€โ”€ .eslintignore
    โ”œโ”€โ”€ .eslintrc.cjs
    โ”œโ”€โ”€ .gitignore
    โ”œโ”€โ”€ .vscode/
    โ”‚   โ”œโ”€โ”€ extensions.json
    โ”‚   โ””โ”€โ”€ settings.json
    โ”œโ”€โ”€ LICENSE
    โ”œโ”€โ”€ examples/
    โ”‚   โ””โ”€โ”€ fetch-and-store.ts
    โ”œโ”€โ”€ package.json
    โ”œโ”€โ”€ pnpm-lock.yaml
    โ”œโ”€โ”€ src/
    โ”‚   โ”œโ”€โ”€ cms.test.ts
    โ”‚   โ”œโ”€โ”€ cms.ts
    โ”‚   โ”œโ”€โ”€ helpers.mocks.ts
    โ”‚   โ”œโ”€โ”€ helpers.test.ts
    โ”‚   โ”œโ”€โ”€ helpers.ts
    โ”‚   โ”œโ”€โ”€ main.ts
    โ”‚   โ””โ”€โ”€ vite-env.d.ts
    โ”œโ”€โ”€ tsconfig.json
    โ””โ”€โ”€ vite.config.ts

โš™๏ธ Tech Stack

  • Node.js v18
  • ESLint + Prettier
  • Typescript v5
  • Vite + Vitest, for compile and testing
  • Image Size, for process images block metadata and obtain type and measures

๐Ÿ“„ License

This project is licensed under the โ„น๏ธ MIT License. See the LICENSE file for additional info.

Free Software, Hell Yeah!

notion-headless-cms's People

Contributors

cntrs avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.