2md 中文文档教程

Question

2md: convert formatted text to markdown

有很多用于将 markdown 转换为 html 的包，但是这个 反过来，将格式化的 html 转换为 markdown。

假设您正在阅读 Ars Technica 文章 并想复制一些东西 进入一些降价笔记。 只需在浏览器中选择一些内容，复制 它，然后运行 ​​2md。 标题、列表格式、粗体文本和超链接 都保存下来了。

您可以在 2md.ca 在线试用。

存在内部结构的详细文章：“Compiling HTML to Markdown 使用 TypeScript：2md 的工作原理” 从命令行

Installation

尝试 2md 的最简单方法是使用 [npx][]，a 自动下载、缓存和运行程序的工具； 它已包含在内 使用 Node.js 自 2017 年以来：

npx 2md [--no-quote] [FILE]

您还可以安装 <带有 yarn 的 code>2md 命令：

yarn [global] add 2md

Usage

运行

npx 2md [--no-quote] [FILE]

以获取 markdown。

默认情况下，2md 从剪贴板读取，使用 osascript, [xclip][], 或 powershell。 否则，将 html 文件的名称作为命令行传递给它 争论。

为了方便地将内容插入到其他文档中，--quote 由 默认并将 markdown 包装在块引用中：

> # Foo
>
> bar ...

API

仅公开一个函数：toMd。

const { toMd } = require('2md');

console.log(toMd('foo <b>bar</b>'));

仅

foo **bar**

支持路径中带有 public 的导出文件。 一切 其他内容如有更改，恕不另行通知。 但如果有一些有趣的 这里的代码你想重用，让我知道，我可以考虑发布 它作为一个单独的包。

Contributing

欢迎投稿！ 有相当全面的端到端和 往返测试，TypeScript 的类型检查使重构更安全， 所以不要害怕移动代码。

License

这里所有的原始代码都是在 Apache License 下获得许可的，版本 2.0，包含在LICENSE.code中； 除了“如何 works”文章how-it-works/post.mdx，它是不可再分发的。

Releasing

当前的发布过程，稍后将被自动化，是：

1. 从 core/package.json 中的 version 字段中删除 -pre 标签 version，并从 website/package.json 中的 2md 依赖

2. 更新 CHANGELOG.md

3. Copy README .md 和任何引用的图像，例如 doc/demo.gif 到 core文件夹

4. 提交git，并

5. 在git tag vA.BCcore目录下，yarn run package和检查 tarball

6. git push --atomic $REMOTE main vA.BC

   可选：找出将 CHANGELOG.md 摘录放入的自动化 自动创建 [GitHub 发布][gh-release]。

   [gh-release]: https://github.com/andrewdotn/2md/releases

7. npm publish 2md-vA.BCtgz

   如果发布预发布，添加 npm publish --tag next 到 [设置 正确的 npm 标签][npm-next]。

   [npm-next]: https://medium.com/@mbostock/prereleases-and-npm-e778fc5e2420

8. 跳转版本并在core/package.json-pre版本后缀代码>; 更新 website/package.json 中的 2md 依赖版本

   Otherwise yarn won’t use the local version.

   纱线工作区文档说，

   if workspace-b depends on a different version than the one referenced in workspace-a’s package.json, the dependency will be installed from npm rather than linked from your local filesystem. This is because some packages actually need to use the previous versions in order to build the new ones (Babel is one of them).

9. 对于预编译版本，在core中运行yarn dist并复制 2md.js 到 ~/bin。 它依赖于一个外壳包装器：

   #!/bin/bash
   
   DIR="$(dirname -- "${0}")"
   
   exec node "${DIR}/2md.js" "${@}"