简介
marked-terminal
是一个基于 marked
的命令行工具,可以将 Markdown 文本转换为终端友好的格式。通过 marked-terminal
,我们可以在终端中方便地查看 Markdown 文件,而不必打开浏览器。
本文将介绍如何使用 marked-terminal
,并提供一些实际的示例来展示它的功能。
安装
使用 npm
可以很方便地安装 marked-terminal
,只需要在命令行中运行以下命令:
npm install -g marked-terminal
这将全局安装 marked-terminal
,可以在任何位置使用该命令行工具。
使用方法
将文件转换成终端友好的格式
要将一个 Markdown 文件转换成终端友好的格式,可以使用以下命令:
marked-terminal <filename>
例如,如果要将 example.md
转换成终端友好的格式,可以运行以下命令:
marked-terminal example.md
在终端中显示 Markdown 内容
要在终端中直接显示 Markdown 内容,可以使用以下命令:
marked-terminal -i
然后输入 Markdown 内容,按 Ctrl + D
结束输入。
自定义样式
marked-terminal
允许使用自定义样式来美化输出结果。可以通过创建 .marked-terminal.css
文件来指定自定义样式。
例如,可以创建一个名为 .marked-terminal.css
的文件,并添加以下 CSS 代码:
code { background-color: #f8f8f8; border: 1px solid #ddd; border-radius: 3px; }
这将使得 marked-terminal
输出的代码块具有浅灰色背景、深灰色边框和圆角。然后,使用以下命令运行 marked-terminal
:
marked-terminal --gfm --breaks --table --emoji --listitem-indent=2 --style=.marked-terminal.css example.md
示例
下面是一些示例,展示了如何使用 marked-terminal
。
示例 1:将 Markdown 文件转换成终端友好的格式
假设我们有一个名为 example.md
的 Markdown 文件,其中包含以下内容:
-- -------------------- ---- ------- - -- ------- - --- - - --- - - --- - --------
要将该文件转换成终端友好的格式,只需在命令行中运行以下命令:
marked-terminal example.md
输出结果如下所示:
-- -------------------- ---- ------- -- ---- ------- - --- - - --- - - --- - --------
示例 2:在终端中显示 Markdown 内容
要在终端中直接显示 Markdown 内容,可以使用以下命令:
marked-terminal -i
然后输入 Markdown 内容,按 Ctrl + D
结束输入。
例如,我们在终端中输入以下内容:
-- -------------------- ---- ------- - -- ------- - --- - - --- - - --- - --------
然后按 Ctrl + D
退出输入模式后,输出结果如下所示:
-- -------------------- ---- ------- -- ---- ------- - --- - - --- - - --- - --------
示例 3:自定义样式
假设我们想要将代码块添加背景色和边框。我们可以创建一个名为 .marked-terminal.css
的文件,并添加以下 CSS 代码:
code { background-color: #f > 来源:[JavaScript中文网](https://www.javascriptcn.com/post/42737) ,转载请注明来源 [https://www.javascriptcn.com/post/42737](https://www.javascriptcn.com/post/42737)