https://github.com/yuma140902/rehype-text-autospace

Rehype plugin to insert padding between full-width and half-width characters
https://github.com/yuma140902/rehype-text-autospace

rehype-plugin

Last synced: about 2 months ago
JSON representation

Rehype plugin to insert padding between full-width and half-width characters

• Host: GitHub
• URL: https://github.com/yuma140902/rehype-text-autospace
• Owner: yuma140902
• License: mit
• Created: 2024-09-14T10:23:20.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-09-14T12:37:16.000Z (4 months ago)
• Last Synced: 2024-10-28T17:19:31.805Z (2 months ago)
• Topics: rehype-plugin
• Language: TypeScript
• Homepage:
• Size: 52.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rehype-text-autospace

[![CI](https://github.com/yuma140902/rehype-text-autospace/actions/workflows/CI.yml/badge.svg)](https://github.com/yuma140902/rehype-text-autospace/actions/workflows/CI.yml)

[![NPM Version](https://img.shields.io/npm/v/rehype-text-autospace)](https://www.npmjs.com/package/rehype-text-autospace)

日本語と英語の間に間隔を開ける [rehype](https://github.com/rehypejs/rehype) プラグインです。

## インストール

```sh

npm install rehype-text-autospace

```

## 使用方法

### unified

[unified](https://github.com/unifiedjs/unified) での使用例です。

```js

import rehypeStringify from 'rehype-stringify'

import rehypeParse from 'rehype-parse'

import rehypeTextAutospace from 'rehype-text-autospace'

import { unified } from 'unified'

const file = await unified()

  .use(rehypeParse)

  .use(rehypeTextAutospace)

  .use(rehypeStringify)

  .process('あいうえおabcかきくけこ')

console.log(String(file))

```

### Astro

[Astro](https://astro.build/) で使用するときの設定例です。

`astro.config.mjs`

```js

import { defineConfig } from "astro/config"

import rehypeTextAutospace from 'rehype-text-autospace'

export default defineConfig({

  // ...

  markdown: {

    rehypePlugins: [rehypeTextAutospace],

  },

  // ...

});

```

## 動作例

以下のマークダウンを rehype-text-autospace を使用して処理した結果と使用せずに処理した結果の比較です。

```md

# rehype-text-autospaceとは

rehype-text-autospaceは日本語と英語の間に自動でスペースを入れる[rehype](https://github.com/rehypejs/rehype) Pluginです。

以下のような環境で使用できます。

- unifiedやAstro

```

rehype-text-autospace 無し

![without](https://github.com/user-attachments/assets/f900e514-3fc5-452b-a679-8aec7bbbef15)

rehype-text-autospace 有り

![with](https://github.com/user-attachments/assets/72ae0a4b-b570-4f95-a3c8-34fec543074d)

## API

### `Options` 型

プラグインの設定

- `padding`?: `string` - 日本語と英語の間にいれる間隔の大きさ。(Default: `".125em"`)

- `fullChars`?: `string` - 全角文字として扱う文字。(Default: `"\\p{Script=Hiragana}\\p{Script=Katakana}\\p{Script=Han}、。「」（）"`)