{"repo":"JabinGP/mdout","free":true,"listed":false,"github":"https://github.com/JabinGP/mdout","clone":"git clone https://github.com/JabinGP/mdout.git","description":"一个Go语言实现的Markdown转PDF命令行工具，基于headless chrome，简单、可靠、易安装、可定制化、易拓展","language":"Go","stars":105,"topics":["markdown-to-pdf","command-line-tool","mermaidjs","jax","headless-chrome"],"license":"Apache-2.0","category":"scrapers-browser-automation","readme_excerpt":"mdout 一个Go语言实现的Markdown转PDF命令行工具，基于headless chrome，简单、可靠、易安装、可定制化、易拓展 如果觉得对你有帮助，点个star鼓励一下作者吧！ 1. mdout有何特点 1.1 简单 mdout会根据后缀，自动识别输入类型 1.2 可靠 mdout可以完整保留你md文件里的代码格式，图片，甚至是jax数学公式，mermaid流程图。 电脑不会如人一般等待页面加载完全再选择打印，电脑自动执行打印时页面尚未渲染完全是件非常头疼的事情，对此，mdout没有简单地使用sleep休眠机制去碰运气，而是实现了一套非常简单的同步渲染机制，即便是你有1万行的mathjax数学公式、1万行的代码语法高亮要渲染，mdout都能完美的保证你的pdf上不会有任何一个未渲染完成的元素。 1.3 易安装 除了chrome，mdout不依赖于其他任何环境，你只需要选择对于系统的安装包，下载并解压即可使用，更为macOS和linux提供了一键安装脚本，为windows提供了丰富的图文教程。 1.4 可定制化 mdout将每个模板独立为主题，并且支持指定输出html文件，可以很方便地自定义页面配色，自定义语法高亮配色。 1.5 易拓展 mdout基于headless chrome，这使得mdout几乎兼容市面上所有能用于的前端组件，并且mdout将组件归类为主题的一部分，你同样可以输出html来调试自己的自定义拓展插件。 2. 获取和安装 见 安装指南 。 使用容器中的mdout，见容器化使用指南 3. 使用说明 mdout依赖于chrome浏览器，如果你的电脑已经安装了新版的chrome浏览器，无需更多配置，可以直接运行mdout，如果是旧版的chrome浏览器，建议进行升级后使用，如果还未安装chrome浏览器，请安装后再使用mdout 3.1. 帮助文档 每个命令行程序都有帮助文档，mdout也不例外 3.2. 最简单的示例 3.2.1. 输入文件路径可以是相对路径 - 文件在当前目录 - 或文件在上级目录 - 文件路径也可以是绝对路径 3.3. 输入文件类型 mdout支持许多输入类型，其中最普遍的就是markdown，但同样也支持html输入，url输入，但是注意，如果输入是url，不要忘记带上 http:// - markdown - html - url 3.4. 输出文件类型 对于markdown输入，mdout支持输出中间过程的结果。但对于html输入或者url输入，它们的唯一输出结果就是pdf文件了 - markdown输出pdf（输出pdf为默认选项) - markdown输出解析后html标签（这个选项可以得到markdown解析器的解析结果） - markdown输出经过处理后的完整html文件（常常用来调试主题） 3.5. 输出路径 mdout支持指定输出路径，输出文件名 你可以使用 -o 来指定输出路径， -o 选项同样做了防呆设计，你可以指定路径但不带文件名，mdout会自动识别你输入文件的文件名和你指定的输出类型为你设置名称，但你同样可以指定路径+文件名 - 指定输出到上级文件夹，自动命名 - 指定输出到 /tmp/markdown 文件夹，自动命名 - 指定输出到当前文件夹下的 badoutput.name 千万不要这么干，尽管程序不会阻止你设置你的文件名，但是使用规范的后缀是个好习惯。 - 指定输出到当前文件夹下的 goodname.pdf 3.6. 指定主题 主题系统只对markdown输入有效","default_branch":null,"files":null,"tree":[],"storefront":"/r/JabinGP","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/JabinGP/mdout/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}