Skip to content

Commit 5d405f9

Browse files
committed
communicate online dep caveat in readme
1 parent ccbe444 commit 5d405f9

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
The plugin adds a code editor view to Obsidian. The code editor uses the powerful
66
[Monaco Editor](https://microsoft.github.io/monaco-editor/), which also powers VS Code.
77

8+
** Caveat: This plugin currently relies on hosted dependencies and thus needs an internet connection.
9+
Read [below](#caveat-online-dependency) for more information. **
10+
811
In the plugin settings, you can configure for which file extensions the editor will be
912
available as default editor. You can also create new code files, either by right clicking
1013
on a folder in the side pane and clicking on "Create Code File", search for
@@ -16,3 +19,13 @@ in the ribbon.
1619
![img_2.png](img_2.png)
1720

1821
![img.png](img.png)
22+
23+
## Caveat: Online dependency
24+
25+
Due to the complicated nature of bundling the Monaco Editor, the plugin currently relies on
26+
a hosted version of the editor. This means that the plugin needs an internet connection to
27+
work, and has a dependency on the hosted editor, which is currently available on
28+
https://embeddable-monaco.lukasbach.com.
29+
30+
I hope to remove this dependency in the future, but this was the easiest way to get the
31+
plugin to work for now.

0 commit comments

Comments
 (0)