README

obsidian-commonmark-extension 是一个针对 CommonMark markdown 解析器的自定义扩展，它添加了一个新的内联元素和渲染器，用于通过可配置的基本 URL 显示图像。还包括用于 obsidian 风格链接和锚点的新的内联元素和解析器

安装

您可以使用 Composer 安装此扩展

composer require dsnr/obsidian-commonmark-extension

使用方法

要使用此扩展，创建一个新的 League\CommonMark\Environment\Environment 实例，使用 addExtension() 方法注册扩展，并将环境传递给一个新的 League\CommonMark\CommonMarkConverter 实例

该扩展期望图像文件名为短横线命名法，例如 example-image.ong

use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment\Environment;
use Dsnr\ObsidianCommonmarkExtension\ObsidianConverterExtension;


$environment = new Environment();
  $environment->addExtension(new ObsidianConverterExtension());

$converter = new CommonMarkConverter([], $environment);

echo $converter->convertToHtml('![[Example Image.png]]);

配置

obsidian-commonmark-extension 包含一个配置架构，它将 obsidian.image_base_url 选项定义为字符串类型，默认值为空字符串。您可以通过传递配置选项数组来修改此选项。

默认情况下，扩展的图像基本 URL 是一个空字符串，因此图像 URL 将按原样显示。要设置自定义的图像基本 URL，请设置 obsidian.image_base_url

use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment\Environment;
use Dsnr\ObsidianCommonmarkExtension\ObsidianConverterExtension;

$config = [
  'obsidian' => [
    'base_image_path' => asset('/images/')
  ]
];

$environment = new Environment($config);
$environment->addExtension(new ObsidianConverterExtension());

$converter = new CommonMarkConverter([], $environment);

echo $converter->convertToHtml('![[Example Image.png]]);

许可协议

obsidian-commonmark-extension 在 MIT 许可协议下发布。

如果您在 README 文件中需要任何进一步的修改或澄清，请通知我。