https://github.com/reonokiy/remark-directive-emphasis-dots
为 Markdown 中文行内文本添加着重号的remark插件
https://github.com/reonokiy/remark-directive-emphasis-dots
chinese emphasis emphasis-dots markdown rehype remark remark-directive unified
Last synced: 5 months ago
JSON representation
为 Markdown 中文行内文本添加着重号的remark插件
- Host: GitHub
- URL: https://github.com/reonokiy/remark-directive-emphasis-dots
- Owner: reonokiy
- License: unlicense
- Created: 2024-07-31T04:13:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-31T04:17:05.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T13:14:01.526Z (over 1 year ago)
- Topics: chinese, emphasis, emphasis-dots, markdown, rehype, remark, remark-directive, unified
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/remark-directive-emphasis-dots
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# remark-directive-emphasis-dots
这是一个为 Markdown 中文行内文本添加着重号的[remark]()插件
## 安装
```sh
npm install remark-directive-emphasis-dots
```
## 用例
```js
import rehypeFormat from 'rehype-format'
import rehypeStringify from 'rehype-stringify'
import remarkDirective from 'remark-directive'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import { unified } from 'unified'
import remarkDirectiveEmphasisDots from 'remark-directive-emphasis-dots'
const text = ":emd[你好]，世界！"
const file = unified()
.use(remarkParse)
.use(remarkDirective)
.use(remarkDirectiveEmphasisDots())
.use(remarkRehype)
.use(rehypeFormat)
.use(rehypeStringify)
.process(text)
console.log((await file).toString())
```
这会产生如下输出：
```
你好，世界！
```
之后，你可以通过自定义CSS来为最终的显示效果添加着重号效果，例如
```css
em.emd {
font-style: normal;
text-emphasis: filled black;
text-emphasis-position: under right;
}
```
### 自定义选项
可以通过向函数中传入配置来更改行为，配置的格式如下
```
...
.use(remarkDirectiveEmphasisDots{
tag: 'emd', /* markdown 中的标记名 */
hName: 'em', /* HTML 中的标签名 */
classNames: ["emd"] /* 为 HTML 标签添加的类 */
})
...
```