notion-to-text v0.1.5

notion-to-text

CLI program which outputs to stdout. It also supports running as server.

Install

using npm

npm i -g notion-to-text

or from sources

git clone https://github.com/pirafrank/notion-to-text
cd notion-to-text/standalone
npm link

Usage

ntt <command> [<args>]

Commands:
  ntt get <URL>  Get content from URL and print to stdout           [aliases: g]
  ntt serve      start the server                                   [aliases: s]

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Examples:
  ntt get <URL>                     get content from notion.site URL
  ntt serve                         start the server on 0.0.0.0:3000
  ntt serve --port 3001             start the server on port 3001
  ntt serve --host "192.168.0.123"  start the server and bind to given host

You need to provide one command at least.

ntt get <URL>

Get content from URL and print to stdout

Options:
      --version  Show version number                                   [boolean]
      --help     Show help                                             [boolean]
  -j, --json     print output in JSON format                           [boolean]

ntt serve

start the server

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]
  --port     port the server listens on                 [number] [default: 3000]
  --host     address the server binds to           [string] [default: "0.0.0.0"]

APIs

Just call server APIs by adding your hostname at the beginning + the response type you want to get.

These are available:

• text or raw for a text/plain response,

• json for an application/json one.

For example:

In case of error, you'll always get an application/json response.

package.json scripts

Command-line

# npm run cli [a *.notion.site url]
# e.g.
npm run cli "https://pirafrank.notion.site"

Server

Start the server

npm run server

Development

.vscode folder in the repository root holds config to run/debug each module (core, standalone and lambda).

Why

Notion is a great note-taking tool and with sites an easy way to maintain a public page. Unfortunately being a PWA you can't get page content just by using curl, so that's where notion-to-text can help.

I've created it for personal use and as such it is provided as-is with no warranties.

License

MIT