tomasr/NoteWrapper
1
0 Fork 0
mirror of https://github.com/tomasriveral/NoteWrapper.git synced 2026-10-11 01:12:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify editor specific features

Browse Source 
Added better explaination and footnote to avoid people oppening
issues/disscussion threads in Vivify instead of NoteWrapper. See
https://github.com/jannis-baum/Vivify/discussions/299
This commit is contained in:
tomasr committed 2026-08-14 17:36:48 +02:00
1 parent eb0d6b6e5d
commit a83da3e1aa
1 file changed
+6 -4
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -4
View File
@@ -158,11 +158,13 @@ NoteWrapper relies on certain editor features, so not all functionality is suppo
### Features requiring editor support:
* **Bufferless rendering**: updates the rendered view while typing (without saving)
* **Cursor following**: rendered view follows the cursor position
* **Jump to end on open**: automatically moves the cursor to the end of the file
* **Bufferless rendering**: updates the rendered view while typing (without saving). You won't need to save the file to see it updated in your browser.
* **Cursor following**: rendered view follows the cursor position. When you scroll in your editor, it will automatically scroll your browser view.
* **Jump to end on open**: automatically moves the cursor to the end of the file when oppening.
The first two features depend on [Vivify's editor integration](https://github.com/jannis-baum/Vivify?tab=readme-ov-file#existing-integration) and are mainly useful if you want external Markdown rendering in your browser.
The first two features depend on [Vivify's editor integration](https://github.com/jannis-baum/Vivify?tab=readme-ov-file#existing-integration)[^1] and are mainly useful if you want external Markdown rendering in your browser.
[^1]: Eventhough the features are Vivify-related, please report bugs and ask questions in this repo.
If your editor does not support these features, you can implement a plugin using [Vivify's API](https://github.com/jannis-baum/Vivify?tab=readme-ov-file#editor-support).