在前端开发中,文档是非常重要的一环。gomdn 是一个可以将 markdown 文档翻译成 google doc 的 npm 包,它提供了方便的方式来展示和编辑文档。
安装 gomdn
方便起见,我们建议您开始配置全局安装:
npm i -g gomdn
如何使用 gomdn
gomdn 的使用非常简单。您需要通过终端运行 gomdn 命令并将 markdown 文件的路径作为参数。例如,如果我们有一个名为 tech.md 的 markdown 文件,我们可以运行以下命令:
gomdn /path/to/tech.md
该命令将使用您的配置文件中提供的 google doc API 密钥(使用 "gomdn config set" 命令指定)将 markdown 翻译成 google doc。
如果您不想全局安装 gomdn,您也可以局部安装它,以便在特定的项目中使用。要实现这一点,只需在项目目录下运行以下命令:
npm i gomdn
然后在您的项目中,您可以像这样使用:
var gomdn = require('gomdn'); gomdn.toGoogleDoc('/path/to/tech.md');
配置 gomdn
在使用 gomdn 之前,您需要在 google cloud 平台上注册,并创建一个项目,以便获得 API 密钥。接下来,您需要将 API 密钥配置到 gomdn 中:
gomdn config set apikey YOUR_API_KEY
之后,您就能够正常使用 gomdn 了。
示例代码
如果您还不确定如何使用 gomdn,以下是一个简单的示例:
# Hello World 这是一个演示 gomdn 的例子!
运行以下命令:
gomdn /path/to/hello-world.md
gomdn 将转换为 google doc,并打开文档以供您编辑和共享。
结论
gomdn 可以为您提供方便的方式将 markdown 转换成 google doc。它可以节省大量时间和精力,将文档转换成易于阅读和编辑的形式。我们希望这篇文章对您有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066e71255dee6beeee7481