https://github.com/janstanleywatt/commonmark-danraku-extension

League/commonmark extension for japanese danraku style.
https://github.com/janstanleywatt/commonmark-danraku-extension

commonmark composer-library markdown php

Last synced: 15 days ago
JSON representation

League/commonmark extension for japanese danraku style.

• Host: GitHub
• URL: https://github.com/janstanleywatt/commonmark-danraku-extension
• Owner: JanStanleyWatt
• License: apache-2.0
• Created: 2023-02-07T12:34:04.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-22T14:37:19.000Z (over 1 year ago)
• Last Synced: 2024-10-19T20:56:33.920Z (27 days ago)
• Topics: commonmark, composer-library, markdown, php
• Language: PHP
• Homepage:
• Size: 41 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CommonMark Danraku Extension

[League/CommonMark](https://commonmark.thephpleague.com/) extension for japanese danraku style.

自動で段落の頭に全角スペースを入れてくれたり、区切り約物の直後に全角スペースを入れてくれる[League/CommonMark](https://commonmark.thephpleague.com/)拡張機能。

## Installation

`$ composer require jsw/commonmark-danraku-extension`

## Usage

```php

$environment = new Environment($config);

$environment

    ->addExtension(new CommonMarkCoreExtension())

    ->addExtension(new DanrakuExtension());

$converter = new MarkdownConverter($environment);

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

//
　この拡張機能は実によい・・・まさに革命的だ

echo $converter->convert($markdown);

```


## config

```php

// 以下、デフォルトでの設定

$config = [

    'jisage' => [

        'ignore_alphabet' => false, // trueにすると、行頭が英数字だった場合には字下げをしなくなる

        'ignore_dash' => true,      // trueにすると、全角ダッシュ（―）、ハイフンで字下げをしなくなる

    ],

    'yakumono' => [

        'spacing_yakumono' => true, // trueにすると、「？」と「！」の前に全角スペースを空けるようになる（閉じ括弧の直前を除く）

        'byte_sensitive' => true,   // trueにすると、全角「？」「！」の場合は全角スペースを、半角「!」「?」の場合は半角スペースを挿入するようになる

    ],

];

```

## Licence

Apache License, Version 2.0  

- [英語原文](https://www.apache.org/licenses/LICENSE-2.0)