Markdown 简介

一次编写,将文本转换为多种格式。 这是 Markdown 入门指南。
277 位读者喜欢这篇文章。
Woman programming

WOCinTech Chat。 由 Opensource.com 修改。 CC BY-SA 4.0

长期以来,我一直认为我在 GitLab 和 GitHub 上看到的带有 .md 扩展名的所有文件都是用一种专为开发人员设计的文件类型编写的。 几周前,当我开始使用 Markdown 时,这种情况发生了改变。 它很快成为我日常工作中最重要的工具。

Markdown 让我的生活更轻松。 我只需要在我已经写的内容中添加一些符号,借助浏览器扩展或开源程序,就可以将我的文本转换为各种常用格式,如 ODT、电子邮件(稍后详述)、PDF 和 EPUB。

什么是 Markdown?

来自 维基百科 的友好提醒

Markdown 是一种轻量级标记语言,具有纯文本格式语法。

这对你来说意味着,通过在文本中仅使用几个额外的符号,Markdown 可以帮助你创建具有明确结构的文档。 当你以纯文本形式做笔记时(例如,在记事本应用程序中),没有任何东西表明哪些文本应该加粗或倾斜。 在普通文本中,你可能会一次将链接写成 http://example.com,然后仅写成 example.com,稍后又写成 访问网站 (example.com)。 没有内部一致性。

但是,如果你按照 Markdown 规定的方式编写,你的文本就具有内部一致性。 计算机喜欢一致性,因为它使它们能够遵循严格的指令,而无需担心例外情况。

相信我; 一旦你学会使用 Markdown,每项写作任务都将在某种程度上比以前更轻松、更好。 那么,让我们学习它吧。

Markdown 基础

以下规则是在 Markdown 中编写的基础知识。

  1. 创建一个带有 .md 扩展名的文本文件(例如,example.md)。 你可以使用任何文本编辑器(甚至是像 LibreOffice 或 Microsoft Word 这样的文字处理器),只要你记住将其保存为文本文件。

Names of Markdown files
  1. 像往常一样,写你想写的任何内容

    Lorem ipsum
    
    Consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 
    Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. 
    Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    
    De Finibus Bonorum et Malorum
    
    Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. 
    Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. 
    
      Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. 
  2. 确保在段落之间放置一个空行。 如果你习惯于写商业信函或传统散文,这可能会感觉不自然,在商业信函或传统散文中,段落只有一个新行,甚至在第一个单词之前可能有缩进。 对于 Markdown,空行(一些文字处理器用 标记,称为 Pilcrow 符号)保证在将其转换为 HTML 等其他格式时会创建新段落。

  3. 指定标题和副标题。 对于文档的标题,在文本前添加一个井号或哈希 (#) 符号和一个空格(例如,# Lorem ipsum)。 第一个副标题级别使用两个 (## De Finibus Bonorum et Malorum),下一个级别使用三个 (### Third Subtitle),依此类推。 请注意,井号和第一个单词之间有一个空格。

    # Lorem ipsum
    
    Consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. 
    Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. 
    Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    
    ## De Finibus Bonorum et Malorum
    
    Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. 
    Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. 
    
      Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. 
  4. 如果你想要 粗体 字母,只需将字母放在两个星号(星)之间,不留空格: **这将是粗体**

Bold text in Markdown
  1. 对于斜体,将文本放在下划线符号之间,不留空格: _我希望这段文字是斜体_

Italics text in Markdown
  1. 要插入链接(例如 Markdown 教程),请将要链接的文本放在方括号中,并将 URL 放在圆括号中,它们之间没有空格

    [Markdown 教程](https://www.markdowntutorial.com/).

Hyperlinks in Markdown
  1. 块引用使用大于号 (>) 符号和空格写在你要引用的文本之前: > 一句名言

Blockquote text in Markdown

Markdown 教程和技巧表

这些技巧将帮助你开始使用 Markdown 写作,但它还有更多功能,不仅仅是粗体、斜体和链接。 学习 Markdown 的最佳方法是使用它,但我建议花 15 分钟时间浏览简单的 Markdown 教程,练习这些规则并学习更多内容。

由于现代 Markdown 是对结构化文本概念的多种不同解释的融合,CommonMark 项目定义了一个具有严格规则的规范,以使 Markdown 更加清晰。 在写作时,手头保留一份 符合 CommonMark 的速查表 可能会有所帮助。

你可以用 Markdown 做什么

Markdown 让你一次编写任何你想要的内容,并将其转换为几乎任何你想要使用的格式。 以下示例展示了如何将用 MD 编写的简单文本转换为不同的格式。 你不需要文本的多种格式——你可以从单一来源开始,然后……统治世界!

  1. 简单笔记: 你可以用 Markdown 编写笔记,在你保存笔记的那一刻,开源笔记应用程序 Turtl 会解释你的文本文件并向你显示格式化后的结果。 你可以在任何地方拥有你的笔记!

Turtl application
  1. PDF 文件: 使用 Pandoc 应用程序,你可以使用一个简单的命令将 Markdown 转换为 PDF: pandoc <file.md> -o <file.pdf>

Markdown text converted to PDF with Pandoc
  1. 电子邮件: 你还可以通过安装浏览器扩展 Markdown Here 将 Markdown 文本转换为 HTML 格式的电子邮件。 要使用它,只需选择你的 Markdown 文本,使用 Markdown Here 将其转换为 HTML,然后使用你最喜欢的电子邮件客户端发送你的消息。

Markdown text converted to email with Markdown Here

开始使用它

你不需要特殊的应用程序来使用 Markdown——你只需要一个文本编辑器和上面的技巧。 它与你已经编写的方式兼容; 你所需要做的就是使用它,所以试一试。

接下来阅读
标签

8 条评论

Markdown 就是生活。

我几乎将其用于所有方面,从内部项目文档到在线游戏的 RPG 游戏表

感谢你写了一篇精彩的 Markdown 简介。

不久前我尝试接触 markdown,但我很快发现的一件事是它有多个版本,这让事情有点混乱。

很高兴发现 Turtl,我会尝试更频繁地使用它。 感谢分享!

感谢这篇精彩的 Markdown 简介!

Asciidoctor 才是真正的王道。 如果你真的在编写文档。 Markdown 对于小片段来说还可以,但 asciidoctor 要好得多。

你指的是 Asciidoctor(处理器),还是 AsciiDoc(Asciidoctor 在其上施展发布魔力的轻量级标记语言)?

无论如何,你是否有兴趣为 Opensource.com 撰写一篇关于 Asciidoctor 的文章? 如果你有兴趣,你可以在此页面上了解如何操作。

回复 ,作者:Martin Sarosi(未验证)

很棒的快速教程,谢谢。
我开始使用 markdown,以便我可以为 opensource.com 撰写文章。 Visual studio code 有一个 markdown 插件,效果很好,而且在 github 上管理文本也很不错,github 会将 markdown 渲染成帮助文档供你使用。

© 2025 open-source.net.cn. All rights reserved.