A comprehensive plugin for viewing, managing, and editing code files in Obsidian
English
·
简体中文
Obsidian does not support viewing, managing, and editing code files out of the box. Code Space was created to solve this problem.
The four layers of "Space":
- Management space: Provides a unified index and management space for code files, allowing you to browse all code files through a visual dashboard.
- Editing space: Enter the code file for a professional code viewing and editing environment.
- Embedding space: Deeply integrates with Obsidian's native features to support references and embedded previews of code files.
- Mount space: Mount external folders into the Vault via system symlinks/junctions for cross-project code management.
Provides a visual dashboard for unified indexing and management of code files within the vault.
- Visual dashboard: An immersive management interface with grid layout and file status overview.
- Integrated management tools: The header integrates Settings and Create file for simpler workflows.
- Multi-dimensional dynamic filtering: Filter by file extension and search by filename in real time.
- Standard file operations: Built-in Obsidian-supported file operations like rename, move, delete, and open in external apps.
Provides an IDE-like environment for code viewing and editing.
- Syntax highlighting: Powered by CodeMirror 6 with accurate highlighting for many languages.
- Structured navigation: Code outline view that parses classes, functions, and methods with click-to-jump navigation.
- Advanced search and replace: Dedicated search panel with regex, case sensitivity, whole-word matching, and global replacement.
- Manual save: Ctrl+S manual save with cursor position protection to prevent viewport jumps.
- Basic editing helpers: Auto indentation, bracket matching, code folding, and line numbers.
- Interaction optimizations: Ctrl+wheel font scaling and a floating search button for quick access.
Elegantly embed and preview code in Markdown, allowing you to embed specific snippets from code files:
- File references: Link code files with
[[filename]]. - Code embedding: Embed previews in Markdown with
![[filename]]. - Line ranges: Specify start lines or line ranges to embed code snippets precisely.
- Quick preview: Hover links to preview code content.
- Bidirectional sync: Automatically detect and notify on external modifications.
Supported embed syntax:
| Syntax | Description |
|---|---|
![[test.py]] |
Embed the entire file |
![[test.py#20]] |
Display from line 20 to end of file |
![[test.py#L20]] |
Same as above (GitHub-style with L prefix) |
![[test.py#20-40]] |
Display lines 20 to 40 |
![[test.py#L20-L40]] |
Same as above (GitHub-style) |
![[test.py#L20-40]] |
Mixed format also supported |
Line range features:
- In range mode, displays the full specified range ignoring the "Max embed lines" setting
- If end line exceeds file length, automatically truncates to end of file
- If end line is less than start line, automatically adjusts to single line display
- Line numbers are consistent with the original file
Break through Vault boundaries to manage external project code.
- Symlinks/junctions: Mount external folders into the Vault by creating symlinks (macOS/Linux) or directory junctions (Windows)
- Seamless integration: Code files in mounted folders appear in the dashboard with full Code Space functionality (editing, embedding, outline, etc.)
- Bidirectional sync: External file modifications automatically sync to Obsidian, and edits in Obsidian are written back to the original location
- Cross-project collaboration: Manage distributed code repositories directly without copying project code into the Vault
Usage:
- Create symlinks/junctions in your Vault pointing to external folders
- Configure management rules in Settings > Code Space > External Folders
- Code Space will automatically recognize and index code files in mounted folders
Important notes!
- Desktop only: External mounts are unavailable on iOS/Android due to sandbox restrictions
- Security risk: External mounts allow the plugin to access files outside the Vault. Only mount folders you trust
- Performance issues: Please do not abuse this feature. You can manage lightweight repositories or perform multi-repository coordination, but avoid mounting too many files or large files arbitrarily
- Path stability: Moving or renaming external folders will break the mount and require reconfiguration
- Sync issues: If external folders are in cloud-synced directories (e.g., Dropbox, OneDrive), ensure Obsidian and external folders are in sync to avoid conflicts
Access configuration via Settings > Community plugins > Code Space:
- Managed Extensions: Specify file extensions managed by Code Space (comma-separated)
- Show Line Numbers: Toggle line numbers (Default: On)
- Max Embed Lines: Maximum lines shown in embedded previews (Default: 30, 0 for unlimited)
- External Folders (Desktop Only): Mount external folders into the Vault via system symlinks/junctions. See the "External Mount Space" chapter above for details.
Note: External mounts allow access to files outside the Vault. Only mount folders you trust.
| Language | Extensions |
|---|---|
| Python | .py |
| C/C++ | .c, .cpp, .h, .hpp, .cc, .cxx |
| JavaScript/TypeScript | .js, .ts, .jsx, .tsx, .mjs, .cjs, .json |
| Web Technologies | .html, .htm, .xhtml, .css, .scss, .sass, .less |
| Systems Programming | .rs, .go, .java, .cs |
| Data/Config | .sql, .yaml, .yml, .xml |
| Scripting | .php, .r |
You can add more languages in plugin settings. The plugin supports managing files with any extension!
- Code files open in the Code Space editor interface
- Binary files (e.g., images or PDFs) open with Obsidian's native viewer. You can even use it to manage attachments like PDFs
Add the following extensions in Settings > Code Space > Managed Extensions to enable:
| Language | Extensions | Highlighting reused from |
|---|---|---|
| XML Family | .svg, .xsd, .xsl, .xslt, .wsdl, .plist, .csproj, .vcxproj, .props, .targets, .config |
XML |
.urdf, .xacro |
XML | |
| C/C++ Family | .ino, .pde, .nut |
C/C++ |
.cu, .cuh, .glsl, .vert, .frag, .hlsl, .mm, .swift |
C/C++ | |
| Java Family | .kt, .kts, .scala, .groovy, .gradle |
Java |
| Frontend Frameworks | .vue, .svelte, .astro |
JavaScript |
| JSON Variants | .json5, .jsonc |
JavaScript |
| Python Family | .pyx, .pxd, .pxi, .ipy |
Python |
| Config Files | .toml, .ini, .cfg, .conf |
YAML |
| Shell Scripts | .sh, .bash, .zsh |
Shell |
| PowerShell | .ps1, .psm1, .psd1 |
PowerShell |
| Other Languages | .cmake, .dockerfile, .diff, .patch, .lua, .pl, .pm, .rb, .erb |
Dedicated |
The following files can also be managed in the Code Space dashboard (rename, move, delete, etc.), but will not be opened by the Code Space editor. They use the system viewer or Obsidian's native viewer.
| Type | Extensions |
|---|---|
| Images | .png, .jpg, .jpeg, .gif, .webp, .svg, .bmp, .ico, .tiff, .psd |
| Documents | .pdf |
| Audio | .mp3, .wav, .ogg, .flac, .aac, .m4a, .wma |
| Video | .mp4, .avi, .mkv, .mov, .wmv, .flv, .webm, .m4v |
| Archives | .zip, .rar, .7z, .tar, .gz, .bz2, .xz |
| Office | .doc, .docx, .xls, .xlsx, .ppt, .pptx |
| Other | .exe, .dll, .so, .dylib, .bin, .dat |
| Command path | Function |
|---|---|
Ctrl+P → "Open code dashboard" |
Open the code management panel |
Ctrl+P → "Create code file" |
Create a new code file |
Ctrl+P → "Reload code space plugin" |
Reload the plugin |
Ctrl+P → "Toggle code outline" |
Toggle the code outline view (Default: On) |
Ctrl+P → "Search and replace" |
Search and replace in the code interface |
| Shortcut | Function |
|---|---|
Ctrl+S |
Manually save the file |
Ctrl+Mouse Wheel |
Adjust font size |
Ctrl+C |
Copy selection |
Ctrl+X |
Cut selection |
Ctrl+V |
Paste content |
Ctrl+A |
Select all |
Ctrl+Z |
Undo |
Ctrl+Y or Ctrl+Shift+Z |
Redo |
Tab |
Increase indent |
Shift+Tab |
Decrease indent |
Enter |
New line and preserve indent |
| Cursor navigation | Selection and editing | ||
|---|---|---|---|
↑ ↓ ← → |
Move cursor up/down/left/right | Shift+Arrow Keys |
Extend selection |
Home |
Jump to line start | Ctrl+Shift+← |
Select to word start |
End |
Jump to line end | Ctrl+Shift+→ |
Select to word end |
Ctrl+← |
Move left one word | Ctrl+Shift+Home |
Select to file start |
Ctrl+→ |
Move right one word | Ctrl+Shift+End |
Select to file end |
Ctrl+Home |
Jump to file start | Backspace |
Delete character before cursor |
Ctrl+End |
Jump to file end | Delete |
Delete character after cursor |
Page Up |
Page up | Ctrl+Backspace |
Delete word before cursor |
Page Down |
Page down | Ctrl+Delete |
Delete word after cursor |
- Open Settings > Community plugins.
- Turn off "Safe mode".
- Click the "Browse" button.
- Search for "Code Space".
- Click "Install" and enable.
- Visit Releases.
- Download
main.js,manifest.json, andstyles.css. Place them in your vault plugin directory:.obsidian/plugins/code-space/. If thecode-spacefolder does not exist, create it manually. - Reload and enable the plugin in Obsidian settings.
Install the BRAT plugin first. When adding a beta plugin in settings, enter this repository address: https://github.com/UNLINEARITY/Obsidian-CodeSpace and select the latest version.
- Node.js 16 or later
- npm
npm install # Install dependencies
npm run dev # Development build (file watching)
npm run build # Production build
npm run lint # Run ESLintobsidian-codespace/
├── src/
│ ├── main.ts # Plugin entry: command registration, view mounting, and lifecycle management
│ ├── code_view.ts # Editor core: CodeMirror 6 editing environment
│ ├── dashboard_view.ts # Dashboard view: file indexing and management UI
│ ├── outline_view.ts # Outline view: sidebar structured navigation
│ ├── code_parser.ts # Syntax parser: multi-language structure analysis
│ ├── code_embed.ts # Embed processing: reference and preview logic
│ ├── dropdown.ts # UI components: dropdown/multi-select
│ ├── folder_filter_modal.ts # Folder filter modal
│ ├── external_mount.ts # External mounts: symlink/junction management
│ ├── settings.ts # Settings panel: plugin configuration
│ └── lang/
│ ├── helpers.ts # Localization helpers
│ └── locale/
│ ├── en.ts # English strings
│ └── zh-cn.ts # Chinese strings
├── styles.css # Styles entry
├── manifest.json # Plugin metadata
└── package.json # Dependencies and scripts
Contributions are welcome via Pull Request!
Please ensure:
- Code passes ESLint checks
- Follow the existing code style
- Commit messages are clear and descriptive
For issues or suggestions, please use GitHub Issues.
- Author: unlinearity
- Email: unlinearity@gmail.com
- MIT License - Copyright (c) 2026 unlinearity
Known limitations:
- Code file contents are currently not indexed by Obsidian's global search engine.
This project is built upon the following excellent projects:
- Obsidian API: Provides powerful plugin extensibility.
- CodeMirror 6: Flexible and modern code editor engine.
- Lezer: Efficient incremental code parsing system.
- TypeScript: Provides robust type safety.
- esbuild: Extremely fast JavaScript bundler.
Make code management simple and efficient in Obsidian!
