Skip to content

Commit 05942dd

Browse files
committed
docs: update readme and changelog
1 parent b16a4e5 commit 05942dd

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66

77

8+
9+
## [Unreleased]
10+
### Added
11+
- Persistent output blocks (Thanks to @chlohal and @twibiral)
12+
13+
814
## [1.12.0]
915
### Added
1016
- Dynamic path changes by adding %USERNAME% to the path (usable for python) (Thanks to @raffy8361)

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -670,6 +670,20 @@ undefined
670670
To manage the open runtimes for Notebook Mode, you can use the `Open Code Runtime Management` command in the command palette. From this sidebar window, you can stop kernels. **Note: force-stopping requires `taskkill` on Windows and `pkill` on Unix. 99% of systems should have these preinstalled: if yours doesn't, please [file an issue](https://github.com/twibiral/obsidian-execute-code/issues/new/choose)**
671671

672672

673+
### Persistent Output \[Experimental\]
674+
675+
Since version 2.0.0, the plugin supports persistent output. This means that the output of a code block is
676+
stored in the note and will be displayed when you open the note again. This is useful for long-running code blocks or
677+
code blocks that produce a lot of output. The output is stored in the note as a comment and will be displayed in the
678+
preview mode.
679+
680+
To enable this feature, you have to enable the setting `Persistent Output` in the plugin settings.
681+
We recommend reopening open notes that contain code blocks after enabling this feature.
682+
683+
This feature is still experimental and may not work as expected in all cases.
684+
We recommend that you disable this feature if you encounter any problems.
685+
686+
673687
## Misc 📦
674688
### Style Settings 🎨
675689

@@ -689,7 +703,7 @@ In your vault go to Settings > Community plugins > Browse and search for "Execut
689703
or
690704

691705
Follow [this link](https://obsidian.md/plugins?search=execute%20code#) and click "Open in Obsidian".
692-
706+
693707

694708
## Locating Path Settings ( ex. JavaScript | Node )
695709

@@ -717,7 +731,6 @@ Do not execute code from sources you don't know or code you don't understand. Ex
717731

718732
## Future Work 📑
719733

720-
- Notebook Mode similar to Jupyter
721734
- Error warning when the execution fails (e.g. when python isn't installed)
722735
- Test if this plugin works in combination with dataview.
723736

0 commit comments

Comments
 (0)