Skip to content
This repository has been archived by the owner on Mar 10, 2023. It is now read-only.

phuctm97/nbundle-notion-outline

Repository files navigation

Notion Outline

Show floating sticky outline (table of contents) for Notion pages, powered by nbundle.

This is an nbundle-powered Notion app bootstrapped with create-notion-app.

Prerequisite

To develop this app, make sure to have the following products installed:

Open your terminal, go to the project directory, and run the following command to install dependencies:

yarn install

Develop

Open your terminal, go to the project directory, and run the following command:

yarn develop --target chrome

The nbundle CLI will open Google Chrome with the app automatically loaded in development mode (hot reloading, error reporting, sourcemap, etc).

Change the --target parameter to edge or firefox if you want to develop on Microsoft Edge or Firefox instead of Google Chrome.

You can edit the app by modifying app/index.jsx. The app auto-updates as you edit the file.

Ship

Open your terminal, go to your project directory, and run the following command:

yarn ship

The nbundle CLI will ask you to log into your nbundle for Developers account if you haven't already, then build & publish the app to all supported platforms. Depending on the target platform, the app may be pending for review & approval.

Learn

To learn more about nbundle and nbundle for Developers, take a look at the following resources: