https://github.com/frencojobs/vscode-notion

Browse Notion pages right inside Visual Studio Code.
https://github.com/frencojobs/vscode-notion

notion vscode-extension

Last synced: 2 months ago
JSON representation

Browse Notion pages right inside Visual Studio Code.

• Host: GitHub
• URL: https://github.com/frencojobs/vscode-notion
• Owner: frencojobs
• License: mit
• Created: 2021-01-02T13:47:04.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-15T06:44:31.000Z (almost 4 years ago)
• Last Synced: 2024-09-29T19:02:49.965Z (2 months ago)
• Topics: notion, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=frenco.vscode-notion
• Size: 22.8 MB
• Stars: 327
• Watchers: 9
• Forks: 15
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - frencojobs/vscode-notion - Browse Notion pages right inside Visual Studio Code. (TypeScript)

README

        
# VSCode Notion

Browse Notion pages directly in Visual Studio Code.

> Disclaimer: This is an unofficial extension made using an unofficial renderer with the data from an unofficial API.



## Features

Here is a list of features that the extension currently supports.

- 📄 View Notion pages while you're coding

- 🔓 Supports both private + public pages

- 🗓️ Browse recently opened pages

- 📌 Bookmark important ones for next times

Here is the checklist for features I'm planning to add to the extension.

- [x] View notion pages

- [x] Support embeddings for certain trusted sources

- [ ] Native syntax highlight for code snippets

- [ ] Authentication for viewing private pages

- [ ] Sidebar for all of user's pages

_Authentication is not currently available since the unofficial API doesn't support much._ But I'm planning to add it as soon as I get access to the official notion API that is coming very soon.

## Configuration

### API

A URL to get the data for Notion pages. By default, it is a hosted version of [Notion Api Worker](https://github.com/splitbee/notion-api-worker) and feel free to host your own and use.

### Access Token

The `Authorization` header to be used when getting the data from the API. Will be empty by default and replace it with your own to view private pages of yours. As of now, you can get the token from `token_v2` of Notion website's cookies in your web browser.

### Allow Embeds

A boolean value to determine whether to allow iframe embeddings when viewing pages. It will be `false` by default.

### Font Family

A comma separated string of font families to use in the pages. Will be `'Helvetica Neue', sans-serif` by default.

### Font Size

The font size in pixels to use in the pages. It will be `14` by default.

### Line Height

The unitless line height value to use in the pages. By default, `1.5` will be used.

---

Here are the available settings with default values.

```json

{

  "VSCodeNotion.api": "https://notion-api.frenco.dev",

  "VSCodeNotion.accessToken": "",

  "VSCodeNotion.allowEmbeds": false,

  "VSCodeNotion.fontFamily": "'Helvetica Neue', sans-serif",

  "VSCodeNotion.fontSize": 14,

  "VSCodeNotion.lineHeight": 1.5

}

```

## Acknowledgement

This project won't be possible without [React Notion](https://github.com/splitbee/react-notion) and [Notion API Worker](https://github.com/splitbee/notion-api-worker) libraries by Splitbee.

## License

MIT © Frenco Jobs