Code Import

by yhao3
5
4
3
2
1
New Plugin

Description

Import code files with @import syntax. Compatible with Markdown Preview Enhanced. - This plugin has not been manually reviewed by Obsidian staff.

Reviews

No reviews yet.

Stats

stars
downloads
0
forks
0
days
NaN
days
NaN
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

Invalid date

Changelog

README file from

Github

Code Import Plugin for Obsidian

Import external code files in your Obsidian notes using @import syntax (compatible with Markdown Preview Enhanced).

🔗 Website · Community plugin page

Screenshots

Desktop

Full file import:

Full Import

Partial import (specific lines):

Partial Import

Mobile (iOS)

Full import Partial import
Mobile Full Mobile Partial

Features

  • Import code files directly in Reading View
  • Support line range selection (line_begin, line_end)
  • Automatic syntax highlighting based on file extension
  • Works with relative paths (including ../)

Syntax

@import "path/to/file.go"
@import "path/to/file.go" {line_begin=4 line_end=14}
@import "examples/main.py" {line_begin=10}
@import "config.yaml" {line_end=-4}

Parameters

Parameter Description (0-based) Description (1-based)
line_begin Start line, 0-based index Start line, 1-based index
line_end End line, exclusive (supports negative) End line, inclusive (supports negative)

Line Index Examples

0-based mode (default, MPE-compatible):

  • {line_begin=0 line_end=10} → Lines 1-10 (indices 0-9)
  • {line_begin=5} → From line 6 to end
  • {line_end=-2} → From start, excluding last 2 lines

1-based mode:

  • {line_begin=1 line_end=10} → Lines 1-10
  • {line_begin=5} → From line 5 to end
  • {line_end=-2} → From start, excluding last 2 lines

Installation

From Community Plugins

  1. Open Settings → Community plugins
  2. Search for "Code Import"
  3. Install and enable

Or install directly from the community plugin page.

Manual Installation

  1. Download main.js, manifest.json, styles.css from Releases
  2. Create folder: <vault>/.obsidian/plugins/code-import/
  3. Copy the files into the folder
  4. Enable the plugin in Settings → Community plugins

Usage

  1. Place your code files in your vault (or reference them with relative paths)
  2. Add @import directive in your markdown file
  3. Switch to Reading View to see the imported code

Example

In your markdown file:

## User Struct Definition

@import "examples/user.go" {line_begin=10 line_end=25}

Settings

Setting Description Default
Show file name Display filename header above code block On
Wrap code Wrap long lines instead of horizontal scrolling Off
Line number base 0-based (MPE-compatible) or 1-based indexing for line_begin/line_end 0-based

License

MIT