purefun/remark-join-cjk-lines

A remark plugin to remove extra space between CJK Characters.

remark-join-cjk-lines

remark-join-cjk-lines is a remark plugin to remove extra space between CJK Characters.

Installation

npm install remark-join-cjk-lines
# or
yarn add remark-join-cjk-lines

Usage

With Remark directly

const remark = require('remark');
const joinCJKLines = require('remark-join-cjk-lines');
remark()
  .use(joinCJKLines)
  .processSync(/*...*/);

With Gatsby

With gatsby-transformer-remark:

// gatsby-config.js
plugins: [
  {
    resolve: `gatsby-transformer-remark`,
    options: {
      plugins: [require('remark-join-cjk-lines')],
    },
  },
],

With gatsby-plugin-mdx:

// gatsby-config.js
plugins: [
  {
    resolve: 'gatsby-plugin-mdx',
      options: {
        extensions: ['.md', '.mdx'],
        remarkPlugins: [require('remark-join-cjk-lines')],
        gatsbyRemarkPlugins: [],
     },
  },
],

With Docusaurus v2

// docusaurus.config.js
module.exports = {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          remarkPlugins: [require('remark-join-cjk-lines')],
        },
      },
    ],
  ],
};

Docusaurus's remarkPlugins take effect in build mode only.

NOTE: Run gatsby clean to take effect.

License

MIT licensed

remark-join-cjk-lines's Issues

CKJ Punctuation

U+300x ~ U+303x

remark@next (13)

Hi!

remark is switching to a new parser internally (micromark, see remarkjs/remark#536 for more info).
From a quick glance at the code, it seems this plugin should be fine. However, it would be good to check that in the future (there is 13.0.0-alpha.0 published now, and one or two more will come before the release)