前言
随着前端技术的不断进步和发展，前端开发的需求也不断增加。对于那些需要使用 markdown 语法来进行文档编写和展示的前端项目而言，markdown 的解析和呈现就成为了一个很重要的工作。
metalsmith-github-markdown 就是一个很好的 npm 包，它可以帮助开发者在前端项目中使用 markdown ，并且通过 github 样式展现页面，使页面更加美观。
本篇文章将会介绍一下如何使用 metalsmith-github-markdown ，并详细说明相关知识，帮助前端开发者更好地使用这个工具。
安装
metalsmith-github-markdown 是一个 npm 包，我们可以通过以下命令进行安装：
npm install metalsmith-github-markdown --save-dev
用法
安装好 metalsmith-github-markdown 之后，我们需要在 metalsmith 框架中使用它。
以下是一个简单的示例，展示了如何使用 metalsmith-github-markdown 解析 markdown 文件：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- -------- - --------------------------------------
---------------------
----------------
-----------------------
----------------
------------ ------ -- -
-- ----- -
----- ----
-
------------------ ------------
---上述代码在当前目录创建了一个简单的 metalsmith 实例，将 ./src 目录中的 markdown 文件解析为 HTML ，并将输出文件放入 ./build 目录中。
在上述示例代码中，我们使用了 metalsmith-github-markdown 的默认设置，这里没有对选项进行特别的设置。如果你需要进行个性化的设置，可以通过传入一个选项对象来传递一些自定义的配置，来完成更加复杂、丰富的功能需求。
选项
在 metalsmith-github-markdown 中，我们可以设置多种不同的选项来达到不同的功能效果。下面是一个语法的示例：
.use(markdown({
gfm: true,
tables: true,
emoji: true
}))gfm控制使用 GitHub 风格的 markdown 语法。tables控制是否解析表格。emoji控制是否解析表情符号。
当然，metalsmith-github-markdown 还有其他很多选项，更多的选项配置可以参考 GitHub-Markdown 的 API 文档。
结论
总的来说，metalsmith-github-markdown 是一个非常方便实用的 npm 包，对于需要在前端项目中使用 markdown 的场景来说，特别是在一些文档编写或者展示页面中，metalsmith-github-markdown 提供了一个很好的解决方案，使文档展示更加美观、方便。
当然，metalsmith-github-markdown 的使用并不仅限于上述示例，还有很多技术细节可以去探索和实践。这里简单列举了一些基本的用法和参数，供大家参考。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f3f1d8e776d08040bad