Source Files

指定したテキスト形式のソースファイルを、構文ハイライト対応の独立ページとして公開します。

English

設定

sourceFiles() では公開対象の include パターンを必ず指定します。ルーティング可能なノートからリンクまたは埋め込みされたファイルだけが公開されるため、下書きや公開予定のノートからソースページが露出することはありません。

import { defineConfig } from "@riebeckite/core";
import { obsidianMarkdown } from "@riebeckite/plugin-obsidian-markdown";
import { codeEnhance } from "@riebeckite/plugin-code-enhance";
import { sourceFiles } from "@riebeckite/plugin-source-files";
 
export default defineConfig({
  plugins: [
    obsidianMarkdown(),
    codeEnhance({ lineNumbers: true }),
    sourceFiles({
      include: ["src/**/*.ts", "scripts/*.ts"],
      exclude: ["src/generated/**"],
    }),
  ],
});

リンクと埋め込み

• [[src/main.ts]] は /source/src/main.ts/ のページへリンクします。
• ![[src/main.ts]] は既存のコードブロック表示経路でソースを表示します。
• #L10 と #L10-L20 は埋め込みの行範囲を選びます。Code Enhance を有効にすると、ソースページでも該当の行または範囲へスクロールし、強調表示します。

ソースページには Vault 相対パス、検出した言語、サイズとダウンロードリンクを表示します。

実行例

以下のソースは、このページ上でソースページへのリンク、ファイル全体の埋め込み、行範囲の埋め込みとして実際に描画されます。

ソース

[[source-file-example.ts]]
 
![[source-file-example.ts]]
 
![[source-file-example.ts#L3-L5]]

実行例

source-file-example.ts

export const greeting = "Hello from a source file";
 
export function greet(name: string): string {
  return `${greeting}, ${name}!`;
}

export function greet(name: string): string {
  return `${greeting}, ${name}!`;
}

安全性と公開境界

include に一致し exclude に一致しないファイルだけが対象です。不正な論理パス、バイナリ、UTF-8 として読めない内容、maxBytes を超えるファイル、代表的な秘密ファイル名・拡張子（.env、鍵、証明書、credentials）は拒否します。設定済みの ContentSource だけを利用し、ファイルシステムのパスを直接読んだり絶対パスを表示したりしません。

オプション

公開 API

• sourceFiles(options) / sourceFiles
• sourceFilePath(path)
• SourceFilesOptions

関連資料

• @riebeckite/plugin-obsidian-markdown
• @riebeckite/plugin-code-enhance