开始使用 Markdown

简介: 原文地址:http://ued.taobao.org/blog/2012/07/getting-started-with-markdown/   本文面向不了解 markdown 或刚准备上手的同学。

原文地址:http://ued.taobao.org/blog/2012/07/getting-started-with-markdown/

 

本文面向不了解 markdown 或刚准备上手的同学。

它是什么

首先,什么是 markdown?我们可以直接看一下 WIKI……不过 wiki
很长,让人没有耐心读下去。那么,简单来说,markdown 其实是一种轻量级的标记语言;
或者说,它规定了一些文本的书写格式,就像这样:

写上你的标题
============

开始书写正文吧

当然也可以用 *列表* 的形式:
*   列表项目
*   还是列表项目

上面这一段东西就是 markdown 了——它看上去和普通的文本没什么两样,只不过文字“被一些
标记 格式化”了,所以看上去会感觉比较漂亮,书面化一点形容叫做 具备更高的可读性

这一段 markdown 给我们的直观感受是我们能够清楚地识别出其中的“标题”、“段落”以及“列表”,
对,就和我们熟知的 html 一样,用来格式化内容

为何使用

接下来的问题自然是,我们为什么要使用 markdown?

我们可以把这个问题进一步拆分为三个问题:

  • 使用 markdown 而不是 html 的好处在哪
  • 在哪些场景下使用?
  • 这个东西的普及度如何?(这意味着它的前途)

接下来一一回答:

  • 前文已说,markdown 和 html 都是一路的标记语言,用来格式化内容。而内容之所以要显得很
    格式化,是因为这样我们更容易阅读和理解。被渲染后的 html 是很可读的,但是 html 代码读起来
    就很糟糕,因为它夹杂着大量 <tag>;而 markdown 不管是写还是读,都很舒服

    有一点需要注意的是,markdown 并不是为了取代 Html,因为根本取代不了。Markdown 的理念是,
    能让文档更容易读、写和随意改。HTML 是一种发布的格式,Markdown 是一种书写的格式

    最后一点,markdown 可以被编译为 html,比如使用在线的 Pandoc

  • 我个人认为,我们在 txt 上写的文档或随手记之类的东西,就完全可以使用 markdown,简单且美观

    另外,最重要的一点,我们可以在 支持把 markdown 编译为 html 的地方书写 markdown,好处是
    显而易见的:书写简单、展现美观。典型的场景有:github 仓库的 README 描述文件、github 中的
    issue、评论框等。总而言之,把它用在要写文档的地方,妥妥的

  • 我们知道,这世界上还有很多类似于 markdown 的轻量级标记语言,比如形形色色的 wiki 语法。所以,
    我们凭什么使用 markdown 而不是 markup 或者 wikidown?

    答案很简单,因为它很流行。至少著名的程序员社区如 github 和 stackoverflow
    都提供了对它的大量支持

说了那么多,结论就是,学习并且使用 markdown,必须的!何况 markdown 学起来非常简单

语法简要介绍

接下来会非常简单地介绍一下语法,而详细的语法大全可以直接去 作者的官网 查看。
作者对语法的介绍富有条理且细致入微。

语法介绍之后会着重说一下几个比较给力的特性,这个部分是重点

部分语法如下:

  • 使用一个或多个空行分隔内容段来生成段落 <p>

  • 标题(h1~h6)格式为使用相应个数的“#”作前缀,比如以下代码表示 h3:

    ### this is a level-3 header ###
    
  • 使用“>”作为段落前缀来标识引用文字段落。这其实是 email 中标记引用文字的标准方式:

    >   引用的内容
    >   这个记号直接借鉴的邮件标准
    
  • 使用“*”“+”“-”来表示无序列表;使用数字加“.”表示有序列表。如:

    1.  I am ordered list item 1...
    2.  So I should be item 2!?
    
  • 使用 4 个以上 空格或 1 个以上 的 tab 来标记代码段落,它们将被
    <pre> 和 <code> 包裹,这意味着代码段内的字体会是 monospace
    家族的,并且特殊符号不会被转义。

    1. 使用 [test](http://example.net "optional title") 来标记普通链接。

    2. 使用 ![img](http://example.net/img.png "optional title") 来标记图片。

    引号内的 title 文字是可选的,链接也可以使用相对路径。

  • 使用 * 或 _ 包裹文本产生 strong 效果:

    _语气很重的文本_ 以及 **语气更重的文本**
    

给力的特性

  • 普通换行并不产生新的段落或 <br>,但是产生空格。

    其实这个和 html 对 line-break 换行 的处理方式是一致的。为了使文本良好地展示在视野内,
    我们会选择 手动地 将文字折行,但是并不意味着这两行在逻辑上不是一个段落。

    我们也可以插入真正的手动换行符 <br>,如果要问 <br> 在什么时候有用,下面是一个例子:

    我 
    其实 
    是一首 
    诗……

    楼上 
    这一段 
    说得漂亮!

  • 支持 setext-style 的 header 定义:

    1. 定义 h1:

      THIS IS THE MAIN TITLE
      ======================
      
    2. 定义 h2:

      This is the subtitle
      --------------------
      

    更低级别的 header 就无法使用这种方式定义了。我们不用管 setext-style 是什么意思,只需要知道
    这种标记方式更能凸显文章标题

  • 在 blockquote(“>”标记的段落) 之内可以嵌套使用其他标签,甚至可以再嵌套
    blockquote——

    上古神书《商古》写道:
    >   今有一鼎,镌以奇文:
    >   >   吾乃鼎,非杯具也。
    
  • 支持引用式的链接格式。什么叫做“引用式”的链接呢,举例来说,
    对于本文中的一段文字,相应的 mkd 代码是:

    首先,什么是 markdown?我们可以直接看一下 [WIKI][1]……
    另外,markdown 可以被编译为 html,比如使用在线的 [Pandoc][2]
    
    
    [1]:    http://en.wikipedia.org/wiki/Markdown   "wiki_markdown"
    [2]:    http://johnmacfarlane.net/pandoc/try    "pandoc online"
    

    看上去就好像是“引用文献”的格式一样。好处非常易见:

    • 正文文本中不会出现 url 链接这种读者不关心的信息,从而不影响读者的阅读
    • 链接地址可以当做一个变量,进行复用
  • 支持快捷链接。一般来说,我们如果要显示一段 url 文本,最好也希望这个 url
    本身能够点击。比如 http://ued.taobao.org

    如果使用 html,则要写作

    <a href="http://ued.taobao.org">http://ued.taobao.org</a>
    

    包含了冗余信息且可读性很差,而在 mkd 中,只要写

    <http://ued.taobao.org>
    

    就 OK 了,非常方便。

结尾

以上便是对 markdown 的一个简要介绍了,需要了解进一步内容的,请移步

目录
相关文章
|
13天前
|
存储 弹性计算 人工智能
【2025云栖精华内容】 打造持续领先,全球覆盖的澎湃算力底座——通用计算产品发布与行业实践专场回顾
2025年9月24日,阿里云弹性计算团队多位产品、技术专家及服务器团队技术专家共同在【2025云栖大会】现场带来了《通用计算产品发布与行业实践》的专场论坛,本论坛聚焦弹性计算多款通用算力产品发布。同时,ECS云服务器安全能力、资源售卖模式、计算AI助手等用户体验关键环节也宣布升级,让用云更简单、更智能。海尔三翼鸟云服务负责人刘建锋先生作为特邀嘉宾,莅临现场分享了关于阿里云ECS g9i推动AIoT平台的场景落地实践。
【2025云栖精华内容】 打造持续领先,全球覆盖的澎湃算力底座——通用计算产品发布与行业实践专场回顾
|
5天前
|
云安全 人工智能 安全
Dify平台集成阿里云AI安全护栏,构建AI Runtime安全防线
阿里云 AI 安全护栏加入Dify平台,打造可信赖的 AI
|
12天前
|
人工智能 自然语言处理 自动驾驶
关于举办首届全国大学生“启真问智”人工智能模型&智能体大赛决赛的通知
关于举办首届全国大学生“启真问智”人工智能模型&智能体大赛决赛的通知
|
8天前
|
人工智能 运维 Java
Spring AI Alibaba Admin 开源!以数据为中心的 Agent 开发平台
Spring AI Alibaba Admin 正式发布!一站式实现 Prompt 管理、动态热更新、评测集构建、自动化评估与全链路可观测,助力企业高效构建可信赖的 AI Agent 应用。开源共建,现已上线!
761 23
|
7天前
|
人工智能 Java Nacos
基于 Spring AI Alibaba + Nacos 的分布式 Multi-Agent 构建指南
本文将针对 Spring AI Alibaba + Nacos 的分布式多智能体构建方案展开介绍,同时结合 Demo 说明快速开发方法与实际效果。
494 37
|
7天前
|
机器学习/深度学习 人工智能 搜索推荐
万字长文深度解析最新Deep Research技术:前沿架构、核心技术与未来展望
近期发生了什么自 2025 年 2 月 OpenAI 正式发布Deep Research以来,深度研究/深度搜索(Deep Research / Deep Search)正在成为信息检索与知识工作的全新范式:系统以多步推理驱动大规模联网检索、跨源证据。
475 41
|
1天前
|
文字识别 监控 物联网
这是我写的实施一地两检的跨境高铁站旅客资料预报系统的系统架构
本文设计了一套基于IAPIS理念的高铁跨境旅客预报与边检联动系统,覆盖青青草原内地与喜羊羊特别行政区间“一地两检”场景。系统在旅客购票后即采集证件、生物特征及行程信息,通过Advance Passenger Info Checker等模块,向出发地和目的地移民管理机构实时推送数据,实现出入境许可预审。支持线上/线下购票、检票、退票全流程管控,结合面部识别、行为追踪技术监控旅客状态,防止滞留或非法通行。列车发车前进行最终核验,确保所有跨境旅客获边检许可。若旅行被中途取消,系统自动改签、退票并通知各方,保障安全与效率。(239字)