简介
metalsmith-typogr 是一个 npm 包,用于执行 Typogr 相关的自动排版和修复工作。它可以轻松地将标点、引号、省略号等符号修正为正确的形式,提高文章可读性。本文将介绍如何使用 metalsmith-typogr 包。
安装
在使用 metalsmith-typogr 之前,需要先安装 metalsmith。如果您已经安装了 metalsmith,则可以直接在项目中安装 metalsmith-typogr。
--- ------- ----------------- ----------
使用
使用 metalsmith-typogr 包很简单。在 metalsmith 的构建中,添加 metalsmith-typogr 插件即可。
----- ---------- - ---------------------- ----- ------ - ----------------------------- --------------------- -------------- ---------
上述代码中,首先引入了 Metalsmith 和 typogr 包,然后通过 Metalsmith 创建了一个构建实例。通过调用 use 方法,绑定了一个 typogr 插件。最后,通过调用 build 方法来执行构建。
参数
metalsmith-typogr 提供了一些选项,用于指定某些修正规则的启用或禁用。以下是 metalsmith-typogr 可接受的选项:
smart
:启用智能引号和破折号的修复。默认为 true。dumb
:禁用智能引号和破折号的修复。默认为 false。widont
:启用连续中文字符的断行。默认为 true。quotes
:指定引号的修复方式。可采用typogr.straight
和typogr.curly
。默认为typogr.curly
。
----- ---------- - ---------------------- ----- ------ - ----------------------------- --------------------- ------------- ------ ----- ----- ------ ------- ----- ------- ------------ --- ---------
示例
以下是一个示例,演示了 metalsmith-typogr 的使用。
----- ---------- - ---------------------- ----- -------- - ------------------------------- ----- ------ - ----------------------------- --------------------- ----------- ------ --- ----- -- ---------------- ----------------------- ------------ ---------------- -------------- ------------ -- - -- ----- - ------------------- - ---
上述代码中,首先引入了 Metalsmith、markdown 和 typogr 包。然后创建了一个构建实例,并在构建中指定了 metadata、source 和 destination 等选项。通过调用 use 方法,分别添加 markdown 和 typogr 插件。最后调用 build 方法来执行构建。
结论
metalsmith-typogr 是一个非常实用和易用的工具。它可用于排版和修正文章中的标点和引号等符号,提高文章的可读性和美观度。我们在项目中应该合理地使用 metalsmith-typogr 包,定期对文章进行修正和优化。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60066f421d8e776d08040df4