rehype-text-autospace

日本語と英語の間に間隔を開ける rehype プラグインです。

インストール

npm install rehype-text-autospace

使用方法

unified

unified での使用例です。

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 で使用するときの設定例です。

astro.config.mjs

import { defineConfig } from "astro/config"

import rehypeTextAutospace from 'rehype-text-autospace'

export default defineConfig({
  // ...
  markdown: {
    rehypePlugins: [rehypeTextAutospace],
  },
  // ...
});

動作例

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

# rehype-text-autospaceとは

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

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

- unifiedやAstro

rehype-text-autospace 無し

rehype-text-autospace 有り

API

Options 型

プラグインの設定

• padding?: string - 日本語と英語の間にいれる間隔の大きさ。(Default: ".125em")
• fullChars?: string - 全角文字として扱う文字。(Default: "\\p{Script=Hiragana}\\p{Script=Katakana}\\p{Script=Han}、。「」（）")