arxiv2notion - GitLite

KO | EN

gitlite — search

#hacktoberfest #machine-learning #linux #macos #windows #awesome #kubernetes #awesome-list #security #pytorch #mcp #ios #openai #open-source

arxiv2notion

(★ 136)

Chrome extension for clipping arXiv articles to Notion.

File Explorer

Download Latest Version (.zip)

- - build.yaml
  - lint.yaml
  - release.yaml
- FUNDING.yml
- pull-request-template.md
- arxiv2notion.gif
- arxiv2notionplus_db.png
- multiple_db.png
- nerf_example1.png
- nerf_example2.png
- .gitkeep
- - options.html
  - popup.html
- - icon128.png
- - notion.js
  - options.js
  - parsers.js
  - popup.js
- - theme.scss
.eslintrc.yml
.gitignore
.prettierrc.yaml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
manifest.json
package-lock.json
package.json
README.md
webpack.config.js

# Installation Guide

1. Get the code

git clone https://github.com/denkiwakame/arxiv2notion

Downloads the entire project code from GitHub to your computer.

cd arxiv2notion

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install

Downloads and installs the libraries listed in package.json.

$ npm run build

Builds optimized production files.

$ npm run watch # debug locally

Type this command into your terminal and run it.

$ npm run pack # packaging to zip

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# arxiv2notion
[![build](https://github.com/denkiwakame/arxiv2notion/actions/workflows/build.yaml/badge.svg)](https://github.com/denkiwakame/arxiv2notion/actions/workflows/build.yaml) [![lint](https://github.com/denkiwakame/arxiv2notion/actions/workflows/lint.yaml/badge.svg)](https://github.com/denkiwakame/arxiv2notion/actions/workflows/lint.yaml)
[![Changelog](https://img.shields.io/badge/changelog-see%20here-blue.svg)](https://raw.githubusercontent.com/denkiwakame/arxiv2notion/main/CHANGELOG.md)
[![GitHub release](https://img.shields.io/github/release/denkiwakame/arxiv2notion.svg)](https://github.com/denkiwakame/arxiv2notion/releases)

#### Supported Format
[![arxiv](https://img.shields.io/badge/arxiv.org-API-red.svg)](https://info.arxiv.org/help/api/index.html)
[![openreview](https://img.shields.io/badge/openreview.net-parser-purple.svg)](https://openreview.net/)
[![acl](https://img.shields.io/badge/aclanthology.org-parser-purple.svg)](https://aclanthology.org/)

Easy-to-use arXiv clipper for [Notion](https://www.notion.so) based on [Notion API](https://developers.notion.com/)

![demo](https://raw.githubusercontent.com/denkiwakame/arxiv2notion/main/doc/arxiv2notion.gif)
![notion](https://raw.githubusercontent.com/denkiwakame/arxiv2notion/main/doc/nerf_example2.png)

## ⬇️ Installation
### a. Install via Chrome Store
- arxiv2notion is now available at [Chrome Store](https://chromewebstore.google.com/detail/arxiv2notion/jfgdgmjlakndggcpknmanlpgjgjbcbli) 🚀.

### b. Install Manually
- download extension package from
https://github.com/denkiwakame/arxiv2notion/releases/latest
- for Chrome, navigate to `chrome://extension`
  - drag and drop the extension from your file manager anywhere onto the extensions page
  - or unzip the extension and `load unpacked` in developer mode

## ⚙️ Setup

### 1. Add arxiv2notion integration
- navigate to [My Integrations](https://www.notion.so/profile/integrations)
- `+ New Integration`
  - **associated workspace:** select your workspace where you save arXiv articles
  - **Type:** select `Internal`
  - **name:** set any name of your choice
<img src="https://github.com/user-attachments/assets/137a6dc2-e280-46d9-8f89-43c6bff9da41" height="200" />

> [!NOTE]
> For more detailed information about Notion integration, please refer to the official documentation at https://developers.notion.com/docs/getting-started.

### 2. Configure the extension
- right-click on the extension icon > `Options`
  - copy **integration id (not the secret token!)** (see figures below) from `https://www.notion.so/my-integrations/internal/${integration-id}`
  - paste the `integration id` and click on `+` button.
  - if your entered id is valid, you can see the following callback messages.

> [!NOTE]
> To enhance security, arxiv2notion retrieves the Notion API key (integration secrets) on-demand through integration ID instead of storing it directly in Chrome local storage. **Please ensure you are logged into notion.so while using this extension.**

<img src="https://github.com/user-attachments/assets/b9e5b87a-e981-4ab6-b59e-75c7c2c7c667" height="300"><img src="https://github.com/user-attachments/assets/d82a0b37-fdc3-44b4-a89f-31997b36a19e" height="300">

### 3. Create databases in Notion
#### from template (recommended)
- clone the public template [here](https://denkiwakame.notion.site/597cdd58bded4375b1cbe073b2ed6f5d?v=63fcbfda57824b239b66e52dde841cdf) to your own notion workspace
- add connection to target databases via `...` > (scroll down...) `Connect to` > `{your integration name}`

<img src="https://github.com/user-attachments/assets/1535ef61-749c-4670-8c37-57ac3d5240b4" height="400">

- Integration will have access writes to all child DBs.

![multiple_db](https://raw.githubusercontent.com/denkiwakame/arxiv2notion/main/doc/multiple_db.png)

#### or manually
- alternatively, you can follow the following steps to create database from scratch in notion
- login to [notion.so](https://www.notion.so) by admin user
- create databases where you save arXiv articles
  - **follow this instruction** https://www.notion.so/guides/creating-a-database and **add properties listed below.**

> [!CAUTION]
> Do **NOT** create a new database by `/database` !
> Make sure to create properties with **exactly the same names and types as those listed.**

|property|type|
|-----|-----|
|Title|Title|
|URL|URL|
|Authors|Multi-Select|
|Abstract|Text|
|Published|Date|
|Comments|URL|
|Publisher|Select|

> [!NOTE]
> **migration from v0.1.x → v1.0.0**
- We changed `Authors` type and added `Published` `Comments` property from [v1.0.0](https://github.com/denkiwakame/arxiv2notion/releases/tag/v1.0.0).
- Change your existing database properties as follows, you can easily integrate new features to your existing Notion database!

|property|type(^v0.1.x)|type(v1.0.0+) |
|-----|-----|-----|
|Authors|Text| **Multi-Select**|
|**Published**|--|**Date**|
|**Comments**|--|**URL**|

> [!TIP]
> You can add extra columns of your choice alongside the default ones in your databases.

#### :bulb: w/ Notion Formula (optional)
- [Notion Formula](https://www.notion.so/help/formulas) allows you to add **custom autofill property** defined by formula.
- For instance, `replace(URL, "arxiv", "ar5iv")` formula adds an [ar5iv link](https://ar5iv.labs.arxiv.org/) column by substituting "arxiv.org" with "ar5iv.org" 🚀
<img src="https://github.com/denkiwakame/arxiv2notion/assets/1871262/687c0e6f-0f63-4f0c-81ce-0b2468c90b0e" height="200">

#### :bulb: w/ Notion AI Property (optional)
- [Notion AI Property](https://www.notion.so/ja-jp/help/guides/5-ai-prompts-to-surface-fresh-insights-from-your-databases) allows you to add **custom autofill property** to each DB record.
- Add column to your Notion DB and select `AI custom autofill`
- Set any prompt you like (e.g. summarization, extracting key ideas ...)
  <img src="https://github.com/denkiwakame/arxiv2notion/assets/1871262/b1a6149a-cf55-41f8-9e83-4578a64530e6" height="200"><img src="https://github.com/denkiwakame/arxiv2notion/assets/1871262/8b30bd04-ffc3-4525-b684-90f8b62dda92" height="200">
- Save an article via `arxiv2notion` ,and then the preset `AI property` will be automatically generated.
  ![image](https://github.com/denkiwakame/arxiv2notion/assets/1871262/ad698cf0-dce0-4b29-8511-47f4c796a694)

## :technologist: Build locally (for Developers)
- See also [CONTRIBUTING.md](CONTRIBUTING.md)

```bash
$ git clone https://github.com/denkiwakame/arxiv2notion.git
$ npm install
$ npm run build
$ npm run watch # debug locally
$ npm run pack  # packaging to zip
```

## Contributors
- Maintainers: [@denkiwakame](https://github.com/denkiwakame), [@wangjksjtu](https://github.com/wangjksjtu)
<a href="https://github.com/denkiwakame/arxiv2notion/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=denkiwakame/arxiv2notion" />
</a>