whojinn/danraku

This package is abandoned and no longer maintained. The author suggests using the jsw/commonmark-danraku-extension package instead.

League/commonmark extension for japanese danraku style.

1.2.1 2022-02-06 15:22 UTC

This package is auto-updated.

Last update: 2023-03-13 11:19:53 UTC


README

PHP Composer Packagist PHP Version Support Packagist Version Packagist Downloads GitHub

Notice

Due to the ID change, I decided to recreate this repository. This repository will no longer be updated. Please refer to this repository instead.

ID変更に伴い、このリポジトリを新しく作り直すことにしました。以後、このリポジトリは更新されません。代わりに、こちらのリポジトリをご参照ください。

Danraku

自動で段落の頭に全角スペースを入れてくれたり、区切り約物の直後に全角スペースを入れてくれるLeague/CommonMark拡張機能。

インストール方法

$ composer require whojinn/danraku

使用方法

$environment = new Environment($config);

$environment
    ->addExtension(new CommonMarkCoreExtension())
    ->addExtension(new DanrakuExtension());

$converter = new MarkdownConverter($environment);

$markdown = 'この拡張機能は実によい・・・まさに革命的だ';

//<p> この拡張機能は実によい・・・まさに革命的だ</p>
echo $converter->convert($markdown);

設定

// 以下、デフォルトでの設定
$config = [
    'danraku' => [
        'ignore_alphabet' => false,     // trueにすると、行頭が英数字だった場合には字下げをしなくなる
        'ignore_footnote' => true,      // trueにすると、FootnoteExtension使用時に脚注には字下げをしなくなる
        'ignore_dash' => true,          // trueにすると、全角ダッシュ(―)、ハイフンで字下げをしなくなる
        'spacing_yakumono' => true,     // trueにすると、「?」と「!」の前に全角スペースを空けるようになる(閉じ括弧の直前を除く)
    ],
];

ライセンス

Apache License, Version 2.0