Skip to content

Commit 34c6fe0

Browse files
authored
Update README.md
1 parent ae80bce commit 34c6fe0

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ The result is shown only after the execution is finished. It is not possible to
2323

2424
<hr></div>
2525

26-
2726
The following [languages are supported](#supported-programming-languages-): C, CPP, Dart, Golang, Groovy, Kotlin, Java, JavaScript, TypeScript, Lean, Lua, CSharp, Prolog, Rust, Python, R, Ruby, Wolfram Mathematica, Haskell, Scala, Racket, F#, Batch, Shell & Powershell, Octave, Maxima, Zig and OCaml.
2827

28+
If you are new to MarkDown or Obsidian.md, you can go to the [Quickstart Guide](#quickstart-guide-) or take a look in to [some blogs and videos that feature this plugin](#featured-in)
2929

3030
Python, Rust, and Octave support embedded plots. All languages support ["magic" commands](#magic-commands-) that help you to access paths in obsidian or show images in your notes.
3131

3232
You can create code blocks that are executed before or after each code block of the same language and define [global code injections](#global-code-injection-and-reusing-code-blocks-).
3333

34-
New: You can [persistent output](#persistent-output-experimental) to store the output of a code block in the note and export it to PDF.
34+
New: You can enable [persistent output](#persistent-output-experimental) to store the output of a code block in the note and export it to PDF.
3535

3636
Take a look at the [changelog](CHANGELOG.md) to see what has changed in recent versions.
3737

@@ -711,6 +711,17 @@ Take a look at the [Obsidian Tools python package](https://github.com/mfarragher
711711
tools for interacting with your vault.
712712

713713

714+
## Quickstart Guide
715+
716+
Start by checking if the plugin is installed and **activated**. Continue by creating a code block in your preferred language. Check above to see if the language is supported.
717+
718+
Now you can switch from the preview mode to the rendered mode (where you can't edit the text anymore). Now, when you hover over the code block, you should see a button labeled "run". Click it!
719+
720+
If it didn't work and a warning appears (that is not related to a bug in your code), you probably need to set the correct execution part for the language (e.g., "C://User/YourName/anaconda/python.exe" or something like that). You can find instructions about how to find the right path below.
721+
722+
Now it works, great! Feel free to read or skim through the text above to learn more features you might like, for example persistent output or embedding of plots.
723+
724+
714725
## Installation 💾
715726

716727
In your vault go to Settings > Community plugins > Browse and search for "Execute Code". Select the plugin, install it and activate it.

0 commit comments

Comments
 (0)