8

编写文档

作为一名开发人员,我一直在寻找编写和更新文档的最简单方法。不是尖叫“不要读我”的无聊文本,而是通过对代码的更简单支持而愉快(且轻松)地格式化的内容。

从 LaTeX 到 wiki 再到 Markdown,仅举几例,我认为 Markdown 已经非常接近了。但是文档本身非常书呆子,而且不是很便携。这需要变成 HTML 和 PDF。

降价编辑器

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

我找到的最简单的编辑器是StackEdit,但它不能很好地导出 HTML;它取决于未正确链接的在线样式表,并且导出的 HTML 非常难以忍受。无论如何,它不会离线工作。

导出 HTML 和 PDF

我正在寻找任何方法来正确地做到这一点。我不介意是否有一些独立的应用程序或脚本可以将markdown文件转换为正确的 HTML。我需要有人向我展示我找不到的文档生成技巧。

PDF 是一个不同的故事。我想我用 HTML 到 PDF 转换器向我的计算机发送了垃圾邮件,并且每个转换器都在我非常干净的文档中添加了垃圾邮件和水印。

4

5 回答 5

9

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

于 2013-08-29T17:29:49.810 回答
6

以下字母表示一些共同特征:​</p>

  • M : 数学公式语法支持

  • G : GitHub 风格的 Markdown

  • L : 实时预览

  • C:代码的语法高亮

  • E : 导出为各种格式

  • S:自定义样式,HTML 的自定义 CSS 等。

  • P : 插件支持

  • F: 免费

  • D:积极发展

他们来了(没有特定的顺序):

1.卓越

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

2.重新文本

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

3.优步作家

小巧轻便 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.哈罗帕德

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

7.标记我的话

简单的 F D L E(pdf html)

8. Gitbook 编辑器

用于文档、数字写作和出版 D F G L C M E (HTML PDF epub mobi)

9.阿比古丁

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

10.代笔人

简单、无干扰、坚固 F G D E (HTML , other formats by extensions), S

11.插入符号

最小,坚固 D L G C E (PDF) M S

13.优雅的 Markdown 编辑器(EME)

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

14. 插件

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

  • 原子

  • Vim:即时降价插件

  • 括号:MarkdownPreview 插件

  • Sublime Text:Markdown 插件

  • GNU Emacs

  • 视觉工作室代码

  • 记事本qq

  • Jetbrains IDE:Markdown Navigator

  • Qownnotes

于 2017-08-25T04:09:30.310 回答
3

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

我发现了这个在线 Markdown-to-PDF 转换器。但是使用在线服务也有一些缺点。他们不仅会污染 PDF(免费午餐?),而且不会将本地图像合并到您的文档中。

这是一个名为 Gimli 的离线 Markdown 到 PDF 转换器,但它在 Ruby 上运行。

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

于 2013-11-06T17:32:10.697 回答
1

你考虑过Doxygen吗?Doxygen 将以多种格式输出(如果需要,可以一次性输出)。我通常使用它来生成 HTML 手册。

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

Doxygen 输出格式列表在这里

Doxygen 手册页面的详细信息:

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

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

于 2013-11-05T14:27:38.920 回答
1

编辑器Atom一个插件来预览 Markdown 文件 (.md),它带有导出为 HTML 功能。

于 2017-08-15T17:18:00.097 回答