Code File Embed (Obsidian plugin)

Embed the current contents of a vault file as a syntax-highlighted code block, instead of copy-pasting code into a fenced block.

Usage

Point a codefile block at a file. The language is inferred from the extension.

```codefile src/foo.abap
```

Line range (1-based, inclusive):

```codefile src/foo.abap:10-25
```

Single line: :10. The path can also go in the block body (first line) if you prefer. Paths resolve like Obsidian links (relative to the current note, shortest-unique names work).

Features

• Syntax highlighting by extension, reusing Obsidian's own renderer (theme + copy button included).
• Live update: the block re-renders when the target file is saved or renamed.
• Optional clickable header showing the file path. The "Header content" setting picks the full vault path, the filename only, or the path relative to the note (examples/demo.ts, climbing with ../ when the file lives outside the note's folder). With the header hidden, a hover button in the top-right corner still opens the source file.
• Settings are searchable from Obsidian's settings search (1.13+); older versions get the same tab rendered the classic way.
• Configurable extension → language map and max file size in settings.

Obsidian Publish

Publish does not run community plugins, so codefile blocks render empty on published sites. To publish, "bake" the embeds first:

• Bake code embeds in current note / all notes (for Publish): converts each codefile block into a plain language fence carrying a marker, with the code inlined:

  ```abap codefile:_src/ZCL_MVO_UTIL.abap:150-219
  ...embedded code...
  ```

  Publish (and any other Markdown renderer) shows it as a normal highlighted code block, and so does Obsidian's reading view: a baked block displays the snapshot that is actually in the note, so what you see is what gets published. Re-run the command any time to refresh baked content from the source files; it is idempotent.

  Prefer an always-current preview over that guarantee? Turn on Live preview of baked blocks in settings and baked blocks render from the source file again — at the cost of reading view no longer matching what will be published once the source drifts from the snapshot.

• Un-bake code embeds: converts baked blocks back into empty codefile blocks.

Development

npm install
npm run dev    # watch build -> main.js
npm run build  # type-check + production bundle
npm test       # unit tests (parser, langMap)

Copy main.js, manifest.json, and styles.css into <vault>/.obsidian/plugins/codefile/ to try it in a vault.

Releasing a new version

Obsidian identifies releases by the version in manifest.json, and the GitHub release workflow (release.yml) refuses tags that don't match it. To ship a version:

1. Bump the version (semver: new feature → minor, fix → patch) in three files, keeping them identical: manifest.json, package.json, and add an entry to versions.json mapping the new version to the minimum Obsidian minAppVersion it needs (raise minAppVersion in manifest.json first if the release uses newer APIs).

2. Commit, then tag with the bare version (no v prefix — Obsidian's convention) and push both:

   git tag 1.1.0 && git push origin main 1.1.0

3. The workflow runs tests, builds, attaches main.js, manifest.json, and styles.css to a GitHub release with provenance attestation. Obsidian's community-plugin updater picks the release up from there.