CodeSuite

Think Jupyter Notebook, but inside your Obsidian vault. VS Code–quality syntax highlighting, live code execution with streaming I/O, shared variables across blocks, and inline graph rendering — with zero extra infrastructure.

---

Features

• Shiki syntax highlighting — 65+ built-in themes, import any VS Code .json theme, auto light/dark switching, full color in Reading view and the editor
• Live code execution — Python, JS/TS, Bash, Go, Ruby, and more; output streams character-by-character; interactive stdin, password masking, cancel mid-run
• Inline graphs — plt.show() and fig.show() are intercepted; Matplotlib and Plotly render below the block without a display server
• Notebook mode — shared execution context across blocks, vars blocks, code_vars: frontmatter, inline `$varname` substitution, Run All (with codesuite:skip opt-out) and Clear Session
• Embedded code files — ![[script.py]] renders as a collapsible, syntax-highlighted, executable block
• Code files in the file explorer — open .py, .js, .sh, … straight from the vault in a lightweight editor with Run + live output, or symlink an external file into your vault with Import code file as alias…
• Environment management — combine a shared .env file with per-vault overrides; reading values is one click away

---

Syntax Highlighting

Powered by Shiki — the exact same engine VS Code uses internally.

• 65+ built-in themes — Gruvbox, Catppuccin, Dracula, Nord, Tokyo Night, One Dark Pro, Rosé Pine, Kanagawa, Everforest, Solarized, Night Owl, Synthwave '84, and many more
• Import any VS Code theme — load a .json file from vscodethemes.com or exported directly from VS Code
• Auto light/dark switching — set a separate theme for each mode; CodeSuite switches when Obsidian's appearance changes
• 36+ languages with common aliases (py, js, ts, sh, rb, …)
• Editor highlighting — full token colors in Live Preview and Source mode via a CodeMirror 6 ViewPlugin, not just in Reading view

---

Code Execution

Run code directly from a code block — no terminal, no switching apps.

Supported runtimes:

Language	Command	Notes
Python	python3	Matplotlib & Plotly graph capture, venv support
JavaScript	node
TypeScript	npx tsx
Bash	bash	Shared variable state across blocks
Zsh	zsh	Shared variable state across blocks
Shell	sh
Go	go run
Ruby	ruby
Lua	lua
Perl	perl
R	Rscript
PHP	php
Swift	swift

• Live streaming — stdout and stderr appear as the process runs, not after it finishes
• Interactive stdin — an input bar appears automatically when your code calls input() or reads from stdin
• Password masking — sudo is detected automatically; the input bar masks characters for sensitive prompts
• Inline graphs — plt.show() and fig.show() are intercepted; graphs render as inline images without a display server
• Virtual environment support — point the Python path to a venv binary; CodeSuite sets VIRTUAL_ENV and prepends bin/ to PATH so all venv packages are available across every language block

---

Notebook Mode: Shared Variables & Run All

Each note maintains an in-memory execution session — the closest thing to a Jupyter notebook inside Obsidian, without a kernel daemon or .ipynb file.

• Shared state across blocks — variables, imports, and function definitions carry over between runs (Python and Bash)
• vars blocks — declare note-scoped variables once; they are injected into every run:

  ```vars
  threshold = 0.85
  dataset = "sales_q4.csv"
  ```
  

• Inline $varname substitution — write `$result` anywhere in your note; it updates live in Reading view after each run
• code_vars: frontmatter — declare the same variables in YAML frontmatter when you prefer note metadata over a fenced block:

  ---
  code_vars:
    threshold: 0.85
    dataset: sales_q4.csv
  ---
  

  A vars block in the body still wins if both define the same key.
• Run All — runs every executable block top-to-bottom in sequence, stopping on the first error. Mark a block with a codesuite:skip marker on its first line (in any comment style — # codesuite:skip, // codesuite:skip, -- codesuite:skip, /* codesuite:skip */, …) to keep it from being run by Run All. Skipped blocks display a small skip badge in their toolbar.
• Clear Session — reset all accumulated state from the note header button
• Copy output — every successful run gets a Copy output pill next to the Clear button

State is per-note, lives only in memory, and resets when Obsidian is closed.

---

Embedded Code Files

Embed any code file from your vault with ![[file.py]] and get a full syntax-highlighted, interactive block instead of plain text.

• Collapsible by default — header shows the filename and line count; click to expand
• Supports Run, Copy, and all execution features just like inline blocks
• Inline blocks can also be made collapsible from settings — useful for long preludes you only want to skim.

---

Vault Code Files & External Aliases

Enable Settings → CodeSuite → Show code files in the file explorer (on by default) and Obsidian will surface every supported code extension (.py, .js, .ts, .sh, .go, .rb, .lua, .rs, .cpp, .swift, …) in the file explorer. Opening one gives you:

• Syntax-highlighted preview mode (Shiki, same theme as your code blocks)
• Switch to edit mode for a lightweight in-vault editor (2-space tab insertion, autosave)
• A Run button for any executable language with live streaming output and Cancel support

Import code file as alias…

Command palette → Import code file as alias… opens a native file picker and symlinks the chosen file into your vault under Imports folder (default: CodeSuiteImports/). The alias behaves like any other vault file — open, edit, and run it without copying its contents. Edits write through to the real file on disk.

---

Installation

Community Plugins (recommended)

1. Open Settings → Community Plugins → Browse
2. Search for CodeSuite
3. Click Install, then Enable

Manual

1. Download main.js, manifest.json, and styles.css from the latest release
2. Create <vault>/.obsidian/plugins/code-suite/
3. Place the three files inside it
4. Reload Obsidian and enable CodeSuite in Settings → Community Plugins

---

Configuration

Open Settings → CodeSuite to configure themes, code execution, environment variables, and embedded file behaviour. See the full configuration reference for all options.

---

Known Limitations

Active-line highlight bleeds into code blocks (editor mode)

When the cursor is inside a code block in Live Preview or Source mode, Obsidian's active-line highlight shows through the block background. This is inherent to how Obsidian's active-line extension works.

Workaround: Enable Auto-switch theme and choose a theme whose background matches Obsidian's active-line color — the bleed becomes invisible.

---

Planned Upgrades

The following features are on the roadmap. Track progress or vote on the linked GitHub issues.

#	Feature	Issue
1	Import / export — round-trip conversion to/from .ipynb; export notes as styled HTML and PDF (including outputs)	#5
2	Better plot support — interactive Plotly graphs (zoom, hover, pan) and a full-screen mode for all plot outputs	#12
3	Per-block code formatting — line highlighting {1,5-10}, diff highlighting ins/del, per-block titles, showLineNumbers override, and inline code syntax highlighting	#13

Shipped in 1.3.0: code files in the file explorer (#4), copy-output button (#6), collapsible inline blocks (#7), .env file support (#8), codesuite:skip for Run All (#9), code_vars: frontmatter (#10), in-vault code editor (#11), import-as-alias command (#14).

---

Contributing

Found a bug or have a feature request? Open an issue on GitHub.

Want to contribute code? See CONTRIBUTING.md for setup instructions and conventions.

---

Credits

• Shiki — syntax highlighting engine (MIT)
• Obsidian — the app this plugin is built for
• CodeMirror 6 — editor framework used by Obsidian

License

Apache 2.0 © Felix Leopold