https://github.com/epicmet/obsidian-nb-plugin

An Obsidian wrapper for nb https://github.com/xwmx/nb
https://github.com/epicmet/obsidian-nb-plugin

nb obsidian

Last synced: 22 days ago
JSON representation

An Obsidian wrapper for nb https://github.com/xwmx/nb

• Host: GitHub
• URL: https://github.com/epicmet/obsidian-nb-plugin
• Owner: epicmet
• Created: 2024-08-19T13:45:55.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-08-20T07:16:03.000Z (5 months ago)
• Last Synced: 2024-10-31T05:05:21.945Z (2 months ago)
• Topics: nb, obsidian
• Language: TypeScript
• Homepage:
• Size: 18.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Obsidian `nb` plugin

> [!Warning]

>

> This plugin is in early stages, Backup you vault and make sure that you know EXACTLY what you're doing.

This is a [`nb`](https://github.com/xwmx/nb) wrapper for Obsidian.

## Installation

> [!IMPORTANT]

>

> Make sure you have `nb` up and running before attempting to enable this plugin.

You need to put the content of the `dist` directory inside your vault's plugins directory.

For example, using [`degit`](https://github.com/Rich-Harris/degit) it looks something like this:

```sh

npx degit \

  epicmet/obsidian-nb-plugin/dist \

  /.obsidian/plugins/obsidian-nb-pluglin # Modify this line

```

After putting it in the right place, reload community plugins from within Obsidian and enable the plugin.

> [!IMPORTANT]

>

> Since you are using `nb` and Obsidian together, you are essentially syncing the `.obsidian` directory which includes your vault's settings and plugins!

>

> I recommend adding such lines to the root `.gitignore` of the `nb` notebook

>

> ```

> .obsidian/plugins/

> .obsidian/workspace.json

> ```

### Why this plugins is not published to Obsidian's community plugins?

It's not registered as a standard community plugin within Obsidian because it's intended for developer use only.