前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >看完这篇,轻松编写Markdown文档

看完这篇,轻松编写Markdown文档

作者头像
Linux兵工厂
发布2023-02-28 13:25:36
9330
发布2023-02-28 13:25:36
举报
文章被收录于专栏:Linux兵工厂Linux兵工厂

Markdown是什么

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

Markdown的优势

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

  • 世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全采用Markdown编辑器的博客平台有Ghost和Typecho等。
  • 用于编写说明文档,以“README.md”的文件名保存在软件的目录下面。
  • Markdown可以快速转化为演讲PPT、Word产品文档甚至是用非常少量的代码完成最小可用原型。

Markdown编辑器

  • 当然,要编写Markdown文档就要用到Markdown编辑器。Markdown编辑器有众多,而作者本人独爱VS Code,为什么这么说?因为VS Code不仅仅可以编写Markdown文件,它简直可以称为程序员的开发利器,支持几乎所有主流的开发语言,可以添加各种扩展控件,而且界面非常友好,关键它是跨平台。自从使用了VS Code后,认为它可以完胜其他IDE工具。
  • 本文主要介绍Markdown,后续会专门介绍VS Code。下面先来看一下通过VS Code编写Markdown文档的图片及支持的扩展。

Markdown语法

  • 下面介绍Markdown常用的语法,基本满足日常文档编写

1. 标题

  • 使用 = 和 - 标记一级和二级标题

2. 段落

  • Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。

3. 列表

  • Markdown 支持有序列表和无序列表。无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记,这些标记后面要添加一个空格,然后再填写内容。

无序列表

有序列表

4. 引用

  • Markdown引用是在段落开头使用>符号,然后后面紧跟一个空格符号

5. 代码引用

  • 如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`)

6. 添加链接

  • 使用方法: [链接名称](链接地址)

例如:Linux兵工厂

7. 添加图片

  • 使用方法:![属性文本](图片地址)

8. 添加表格

  • 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
代码语言:javascript
复制
|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

9. 加粗文字

  • 语法:**加粗**

10. 斜体

  • 语法:*斜体*

结束语

  • Markdown基本介绍就到这里,后续会输入Markdwon的高级用法
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2022-12-12,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 Linux兵工厂 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • Markdown是什么
  • Markdown的优势
  • Markdown编辑器
  • Markdown语法
    • 1. 标题
      • 2. 段落
        • 3. 列表
          • 4. 引用
            • 5. 代码引用
              • 6. 添加链接
                • 7. 添加图片
                  • 8. 添加表格
                    • 9. 加粗文字
                      • 10. 斜体
                      • 结束语
                      领券
                      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档