如何将Markdown文档导出为不同的格式?

时间:2013-08-29 13:50:45

标签: html pdf documentation editor markdown

编写文档

作为开发人员,我一直在寻找编写和更新文档的最简单方法。这不是一个无聊的文字,它会尖叫“不要读我”,但是可以通过额外的代码支持来快乐(并且轻松地)格式化。

从LaTeX到wiki再到Markdown,仅举几例,我认为Markdown几乎与它相近。但该文件本身非常讨厌,不太便携。这需要成为HTML和PDF。

Markdown Editor

所以基本上我正在寻找一个编辑器,转换器,或者我没有想到的任何聪明的技巧,将这个文档转换为HTML和PDF。

传下我发现的最简单的编辑器StackEdit,但它不能很好地导出HTML;它取决于未正确链接的在线样式表,并且导出的HTML非常难以忍受。无论如何它都无法脱机工作。

导出HTML和PDF

我正在寻找任何方式来正确执行此操作。我不介意是否有一些独立的应用程序或脚本将markdown文件转换为适当的HTML。我需要有人向我展示我无法找到的文档生成技巧。

PDF是一个不同的故事。我认为我用HTML-to-PDF转换器将我的计算机充满垃圾邮件,并且每个转发器都为我非常干净的文档添加了垃圾邮件和水印。

5 个答案:

答案 0 :(得分:6)

对于输出格式的选择,你可能无法击败pandoc - 它会将Markdown(以及许多其他格式)转换为HTML,PDF,DocBook等等。它的默认值非常合理,但如果您愿意,可以轻松地包含自己的模板。它还支持以块为单位突出显示特定于语言的代码。

答案 1 :(得分:3)

只是为了补充以前的答案:

我找到了this online Markdown-to-PDF converter。但使用在线服务有一些缺点。它们不仅可以污染PDF(免费午餐吗?),而且它们也不会将本地图像合并到您的文档中。

这是一个offline Markdown-to-PDF converter called Gimli,但它在Ruby上运行。

还有另一个离线转换器MultiMarkdown to PDF,但它使用的是Windows。

答案 2 :(得分:3)

以下字母表示一些常见功能:

  • M :数学公式语法支持

  • G :GitHub风味降价

  • L :实时预览

  • C :代码

  • 的语法高亮显示
  • E :导出为各种格式

  • S :自定义样式 HTML等自定义CSS

  • P :支持插件

  • F:免费

  • D:积极发展

他们来了(没有具体的顺序):

1。 Remarkable

简洁,优雅,功能丰富 D F L G S P M C E(pdf, html)

2。 ReText

简单,支持重组文本和降价 D F M P E(html, odt, pdf)

3。 UberWriter

极简轻巧 F C M E(pdf html rtf)

5。 Typora

简单,优雅 F(while in beta) D G C M L E(html pdf epub docx odt etc.)

6。 Haroopad

功能丰富的博客和邮寄测试编辑器,可导入多种格式 F G L M E(html)

7。 Mark My Words

简单 F D L E(pdf html)

8。 Gitbook Editor

用于文档,数字写作和发布 D F G L C M E (HTML PDF epub mobi)

9。 Abricotine

基于网络技术的编辑器 L F D G C E(HTML) M S

10。 GhostWriter

简单,无干扰,强大 F G D E (HTML , other formats by extensions), S

11。 Caret

最小,健壮 D L G C E (PDF) M S

13。 Elegant Markdown Editor (EME)

最小,简单 D L G C E (PDF) M

14。插件

以下是适用于各种IDE和编辑器的插件。有些插件可以转换为HTML或PDF。去看一下。   - 原子

  • Vim:Instant-Markdown插件

  • Bracket:MarkdownPreview插件

  • Sublime Text:Markdown Plugin

  • GNU Emacs

  • Visual Studio代码

  • Notepadqq

  • Jetbrains IDE:Markdown Navigator

  • Qownnotes

答案 3 :(得分:1)

您考虑过Doxygen了吗? Doxygen将以多种格式输出(如果需要,可以同时输出)。我通常用它来生成HTML手册。

Doxygen主要用于记录代码,但如果您只是编写一个独立的手册,那么与页面和部分相关的命令将会做得非常好。

Doxygen输出格式列表为here

Doxygen Manual page的详细信息:

  

PDF:   通过在中运行make pdf从LaTeX输出生成   输出目录。要改善PDF输出,通常需要   通过将USE_PDFLATEX设置为YES来启用pdflatex的使用   配置文件。为了获得PDF文件中的超链接   还需要启用PDF_HYPERLINKS。

注意:您需要TeX设置才能使用它。 Doxygen本身不会产生所需的输出,但这也适用于Pandoc

答案 4 :(得分:1)

编辑器Atoma plugin来预览Markdown文件(.md),其中包含导出为HTML功能。