GithubHelp home page GithubHelp logo

me-imfhd / notebook Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 1.0 659 KB

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.

Home Page: https://notebook-two-swart.vercel.app/docs

JavaScript 0.06% TypeScript 1.18% CSS 0.06% MDX 98.70%
documentation nextjs nextra notion blogs

notebook's Introduction

logo

Notebook

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

contributors last update forks stars open issues license

logo

Sample App made from 100xdev cohort open source notion pages

🧰 Setup Next.js and Nextra

Create nextjs Project with default configurations

  npx create-next-app

Install Dependencies

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

Create theme.config.jsx file

  export default {
    logo: <span>My Notebook </span>,
    project: {
      link: 'https://github.com/me-imfhd/notebook'
    }
    // ... other theme options
  }

Update next.config.mjs

  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);

🧰 Autogenerate docs with notebook

Use notebook sdk

  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,
  });

🤝 Contact

My Twitter - @mefhd2

notebook's People

Contributors

me-imfhd avatar

Stargazers

 avatar Tom Hackshaw avatar

Watchers

 avatar

Forkers

et0and

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.