用户工具

站点工具


others:markdown

这是本文档旧的修订版!


使用markdown写作并生成技术文档

markdown概述

Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。甚至Markdown能被使用来撰写电子书。

Markdown语法参见:Markdown语法介绍(Coding)Markdown基本语法(简书)

环境安装

Markdown写作生成环境包括写作环境和文档生成环境两部分:

  • 写作环境主要用于书写markdown文件
  • 文档生成环境主要用于实现markdown转换为pdf文档

写作环境

Markdown的规范本身就是文本文档,故任何文本文件编辑器均可进行markdown文件的编辑,编辑markdown文件可以使用专业的编辑器,也可以在IDE环境中安装markdown的插件。

目前业内常用的markdown文件编辑器主要包括:

  • sublime
  • remarkable
  • markdownpad
  • Typora
  • ……

IDE环境:

文档生成环境

markdown生成pdf主要需要使用pandoc和latex(texlive/miktex)两个工具,具体安装方式如下:

pandoc的安装

Pandoc是由John MacFarlane开发的标记语言转换工具,可实现不同标记语言间的格式转换,堪称该领域中的“瑞士军刀”。Pandoc使用Haskell语言编写,以命令行形式实现与用户的交互,可支持多种操作系统。

  • Windows下的安装:下载安装包直接安装即可
  • Linux下的安装:Pandoc已经包含在大部分Linux发行版的官方仓库中,直接使用诸如apt/dnf/yum/pacman之类的安装工具直接安装即可
  • MacOS下的安装:建议通过HomeBrew进行安装即可
详细的安装说明参见:官方安装文档

latex的安装

latex工具,在windows下建议安装miktex,Linux和MacOS下建议安装texlive

  • windows环境:下载安装miktex
  • Linux环境:使用apt/dnf/yum/pacman等安装工具安装texlive、texlive-latex等相关软件包即
  • MacOS:使用HomeBrew安装texlive即可

安装后的设置及写作要求

安装后的设置

写作要求

示例

  • 源文件
  • 生成的PDF文件
others/markdown.1566971057.txt.gz · 最后更改: 2020/07/12 12:07 (外部编辑)