https://github.com/me-imfhd/notebook

Notebook helps you create documentation app for anything with notion pages easily. Worry about writing notion pages, let notebook create a documentation app for your work.
https://github.com/me-imfhd/notebook

blogs documentation nextjs nextra notion

Last synced: 2 months ago
JSON representation

Notebook helps you create documentation app for anything with notion pages easily. Worry about writing notion pages, let notebook create a documentation app for your work.

• Host: GitHub
• URL: https://github.com/me-imfhd/notebook
• Owner: me-imfhd
• Created: 2024-01-09T10:32:49.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-06-07T17:48:30.000Z (7 months ago)
• Last Synced: 2024-10-17T22:42:27.023Z (2 months ago)
• Topics: blogs, documentation, nextjs, nextra, notion
• Language: MDX
• Homepage: https://notebook-two-swart.vercel.app/docs
• Size: 644 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  

  
Notebook

  


   Notebook effortlessly transforms Notion pages into a tailored documentation app for your needs.

  




  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  





    Report Bug

   · 

    Request Feature

  








### Sample App made from 100xdev cohort open source notion pages



    100xdevs Notebook



## :toolbox: Setup Next.js and Nextra

Create nextjs Project with default configurations

```bash

  npx create-next-app

```

Install Dependencies

```bash

  npm i nextra nextra-theme-docs nextra-theme-blogs @meimfhd/notebook

```

Create theme.config.jsx file

```bash

  export default {

    logo: My Notebook ,

    project: {

      link: 'https://github.com/me-imfhd/notebook'

    }

    // ... other theme options

  }

```

Update next.config.mjs

```bash

  import withNextra from "nextra";

  const withNextraConfig = withNextra({

    theme: "nextra-theme-docs",

    themeConfig: "./theme.config.jsx",

  });

  /** @type {import('next').NextConfig} */

  const nextConfig = {}; // Your old next.js configuration if any

  export default withNextraConfig(nextConfig);

```

## :toolbox: Autogenerate docs with notebook

Use notebook sdk

```bash

  import { notionToNextra } from "@meimfhd/notebook";

  const NOTION_INTEGRATION_TOKEN = process.env.NOTION_INTEGRATION_TOKEN?;

  await notionToNextra({

          pageId: "your-notion-page-id",

          rootRouteName: "docs",

          rootRouteTitle: "My Notebook",

          token: NOTION_INTEGRATION_TOKEN,

  });

```

## :handshake: Contact

My Twitter - [@mefhd2](https://twitter.com/mefhd2)