草庐IT

【超用心整理】Markdown常用语法介绍,看这一个就够了

海星啊 2023-04-09 原文

Markdown常用语法介绍

Markdown是一种使用一定的语法将普通的文本转换成HTML标签文本的编辑语言,它的特点是可以使用普通的文本编辑器来编写,只需要按照特定的语法标记就可以得到丰富多样的HTML格式的文本。本文就来介绍一些常用的Markdown语法以及推荐几款方便又实用的Markdown编辑器。

换行问题

换行是markdown最基本的语法规则,也是它不同于普通文本的地方,想要在某一行之后进行换行只按常规的Enter键是不行的。换行有3种方式:

  1. 在行的末尾添加至少两个空格,然后再接Enter另起一行;
  2. 第2种方式是在需要换行的两行内容之间空一行;
  3. 第3种方式是在需要换行的内容末尾添加一个换行标签,也就是<br>标签。

标题分级

在当前行之前输入 “#”+"空格"可以使当前行被识别为标题

"# " -> 一级标题是
"## " -> 二级标题
"### " -> 三级标题

标题分级另一种写法

在当前行的下一行输入一个或者多个"=“和”-"可以使当前行被识别为标题

“这是一个一级标题”
“=”

“这是一个二级标题”
“-”

分割线

使用三个或以上的 “-” 或者 “*” 表示(混合的不行),且这一行只有符号,注意不要被识别为二级标题即可,意思是上面需要是空行,例如中间或者前面可以加空格。

语法

***
******
---
------

斜体和粗体

使用 (*或者_ )和( **或者__) 分别表示斜体和粗体,删除线使用两个 ~ 表示

语法

*我是斜体*
_我是斜体_
**我是加粗**
__我是加粗__
~~我是删除~~
***我是又粗又斜***
___我是又粗又斜___

超链接和图片引用

超链接

内联超链接

使用[链接文字](链接地址)来表示,如果要给链接一个提示信息,可以在链接用引号把文字包围起来,就像这样[链接文字](链接地址+空格+"文字说明")

语法

[链接例子《就是外在文字》](http://www.baidu.com/" 我是说明文字:我其实就是HTML 的<a> 标签的 Title 属性")

自动超链接

以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用<>包起来, Markdown 就会自动把它转成链接

语法

<http://example.com/>

引用式链接

在任意地方使用[链接引用标记]:链接地址+空格+"文字说明" 来定义引用的链接地址,然后使用[链接文字][链接引用标记]放在需要插入链接的地方

语法

[link1]:http://www.baidu.com/ “baidu.com 其实就是HTML 的<a> 标签的 Title 属性”
[引用式链接例子《就是外在文字》][link1]

引用式链接-简化

该功能让你可以省略指定链接标记,这种情形下,链接标记会视为等同于链接文字,只要在链接文字后面加上一个空的方括号,如果你要让 “Google” 链接到 google.com,这么写就行

语法

[Google][]
[Google]: http://google.com/

图片引用

内联式图片引用

图片引用仅在超链接前多了一个 ! ,一般是![图片文字](图片地址+空格+"文字说明")

语法

![图片例子《就是Alt属性》](http://www.baidu.com/images/logo.png “我是说明文字:我其实就是HTML 的<a> 标签的 Title 属性”)

引用式图片引用

在任意地方使用[图片引用标记]:图片地址+空格+"文字说明" 来定义引用的图片链接地址,然后使用[图片文字][图片引用标记]放在需要插入图片链接的地方

语法

[link2]:http://www.baidu.com/images/logo.png “baidu.com 其实就是HTML 的<a> 标签的 Title 属性”
![引用式图片链接例子《就是Alt属性》][link2]

带有链接的图片

部分markdown编辑器只需要将链接代码套在图片代码外边就可以实现。

语法

[![图片例子](http://www.baidu.com/images/logo.png “图片说明文字”)](http://www.baidu.com/ “链接说明文字”)

无序列表

使用 -+*+空格 +文字内容 表示无序列表
可用tab 或者空格 + -+ 或者 * +文字内容使列表嵌套
成功嵌套的条件是下一层的-+* 的前面的空白长度满足以下条件

tab长度×(层数-1) < 空白长度 ≤ tab长度×层数

 + 第一层
   * 第二层
    + 第三层

 + 再来一个第一层

有序列表

使用 1. +空格 +文字内容 表示有序列表,可嵌套。
可用tab 或者空格 + -+ 或者 * +文字内容使列表嵌套
成功嵌套的条件是下一层的-+* 的前面的空白长度满足以下条件

tab长度×(层数-1) < 空白长度 ≤ tab长度×层数

语法

 1. 第一层
   1. 第二层
    1. 第三层

  2. 再来一个第一层

实例

  1. 第一层
  2. 第二层.1
  3. 第二层.2
    1. 第三层.1
    2. 第三层.2
  4. 第二层.3
  1. 在列表结束敲二个空行,在第二个空行中写入任何内容都可以重开一个计数列表

文字引用

使用 > 表示,可以有多个 >,表示层级更深

要从深层到浅层需要在浅层上方留一个有与层数相同个数 >的空行

语法

>文字内容
>文字内容
>>文字内容
>
>文字内容
>文字内容

实例

文字内容
文字内容

文字内容

文字内容
文字内容

行内代码块

使用 " ` " 把代码包围起来即可

语法

`a = 1`

如果要在代码区段内插入反引号,你可以用多个反引号来开启和结束代码区段:

语法
`` There is a literal backtick (`) here.``

代码块

方法一

使用四个空格缩进表示代码块,

语法

  import os
  print("hello world")
  def show_time():
  return time.time()

方法二

一些 IDE 支持行数提示和着色,一般使用三个 " ` " 表示,例如
代码块使用3个 " ` "包围起来表示,而且代码块的第一行的3个 " ` " 后面可以写上代码的编程语言,方便Markdown转化之后进行高亮显示,如写上python或者js

语法

```python
import os
print("hello world")
def show_time():
return time.time()
`` `

表格

表格由3个部分组成

第一个部分是表格的标题,使用|来作为列的分割
第二个部分是表示列的对齐方式,有左对齐、居中对齐和居右对齐三种类型,直接看例子吧, --- 表示了默认的左对齐:--- 表示 左对齐---: 表示 右对齐:---: 表示居中对齐
第三个部分就是内容了,表示方式跟标题一样,可以有多行

语法

|左对齐标题|右对齐标题|居中对齐标题|
|-|------: |:------: |
|居左|居右|居中|
|测试文本|测试文本|测试文本|

实例

左对齐标题右对齐标题居中对齐标题
居左居右居中
测试文本测试文本测试文本

流程图

不同的Markdown解析器原理不同,不一定支持流程图
obsidian 支持 mermaid 流程图。其他的流程图也许要安装插件
mermaid文档: https://mermaid-js.github.io/mermaid/#/README
mermaid在线编辑器: https://mermaid-js.github.io/mermaid-live-editor

语法

  ```mermaid 
  sequenceDiagram
  Alice->>John: Hello John, how are you?
  loop Healthcheck
  John->>John: Fight against hypochondria
  end
  Note right of John: Rational thoughts!
  John-->>Alice: Great!
  John->>Bob: How about you?
  Bob-->>John: Jolly good!
  ```

实例

Alice John Bob Hello John, how are you? Fight against hypochondria loop [Healthcheck] Rational thoughts! Great! How about you? Jolly good! Alice John Bob

数学公式

支持 LaTeX 编辑显示支持,
使用 $ 表示,其中一个 $ 表示在行内,两个 $ 表示独占一行。

eg : ∑ i = 1 n a i = 0 \sum_{i=1}^n a_i=0 i=1nai=0

参考教程:https://1024th.github.io/MathJax_Tutorial_CN

推荐一个常用的数学公式在线编译网站:https://www.latexlive.com

HTML引用

直接在Markdown里面写HTML即可

CSS 样式相关

样式标签

<b>加粗</b>
<strong>加粗</strong>
<i>倾斜</i>
<em>倾斜</em>
<u>下划线</u>
<ins>下划线</ins>
<s>删除线</s>
<del>删除线</del>
<sub>下标</sub>
<sup>上标</sup>

内联样式

<b style=“font-size:80px; color:red”>加粗</b>

<style>标签

<style>
h1{
font-size:80px;
color:#7ecef4;
text-intent:10px;
}
</style>

<link>引用外部CSS

<link href=“main.css” rel=“stylesheet”>

这种方式,某些Markdown渲染器可以,反正obsidian是不行

HTML 内容相关

在Markdown中可以展示出网页内容
支持的也就是普通的内容,交互式的标签基本都被和谐了
HTML教程:https://www.runoob.com/html/html-tutorial.html

例子,用html的 <a><img> 标签实现带连接的图片

<a href =“超链接地址”><img src=“图片地址”></a>

JavaScript 脚本相关

很多Markdown渲染器是不允许js跑起来的

外部引用和直接写这两种基本都跑不起来
<script src=“javascript.js”></script>

<script>
console.log(“hello world!”)
</script>

内联事件的js可能可以跑起来,反正obsidian是不行
<div οnclick=“(function(){ alert(1)})()”>js测试按钮</div>

反斜杠转义

由于Markdown的语法基本都是用的符号表示,所以当需要直接输出某些特定的符号的时候,就必须使用反斜杠的转义作用了,使用方法很简单,跟大部分的编程语言的用法一样,只需要在特定的符号前面加上一个反斜杠就可以了,例如输出\本身,就需要使用\\来表示了。

Todo List

-/+/*+空格+[+空格/x+] +空格+文字内容

语法

- [ ] 待办事项
- [x] 已完成的待办事项

实例

  • 待办事项
  • 已完成的待办事项

脚注

在文档末尾写上[+^+数字+]:+文字内容 声明一个脚注
然后就跟文献引用一样,在要引用该脚注的文字后插入[+^+数字+]即可

语法

该方法根据实验证明有效[^1]
[^1]:文章链接


感谢您花费时间阅读,本文内容可能有疏漏之处,欢迎更改指正。
Author : Luanhaixin
Date : 2022-05-06

有关【超用心整理】Markdown常用语法介绍,看这一个就够了的更多相关文章

  1. ruby-on-rails - Rails 常用字符串(用于通知和错误信息等) - 2

    大约一年前,我决定确保每个包含非唯一文本的Flash通知都将从模块中的方法中获取文本。我这样做的最初原因是为了避免一遍又一遍地输入相同的字符串。如果我想更改措辞,我可以在一个地方轻松完成,而且一遍又一遍地重复同一件事而出现拼写错误的可能性也会降低。我最终得到的是这样的:moduleMessagesdefformat_error_messages(errors)errors.map{|attribute,message|"Error:#{attribute.to_s.titleize}#{message}."}enddeferror_message_could_not_find(obje

  2. ruby - 使用 Vim Rails,您可以创建一个新的迁移文件并一次性打开它吗? - 2

    使用带有Rails插件的vim,您可以创建一个迁移文件,然后一次性打开该文件吗?textmate也可以这样吗? 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件,这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails,您可以创建一个新的迁移文件并一次性打开它吗?,我们在StackOverflow上找到一个类似的问题: https://sta

  3. ruby-on-rails - Rails - 一个 View 中的多个模型 - 2

    我需要从一个View访问多个模型。以前,我的links_controller仅用于提供以不同方式排序的链接资源。现在我想包括一个部分(我假设)显示按分数排序的顶级用户(@users=User.all.sort_by(&:score))我知道我可以将此代码插入每个链接操作并从View访问它,但这似乎不是“ruby方式”,我将需要在不久的将来访问更多模型。这可能会变得很脏,是否有针对这种情况的任何技术?注意事项:我认为我的应用程序正朝着单一格式和动态页面内容的方向发展,本质上是一个典型的网络应用程序。我知道before_filter但考虑到我希望应用程序进入的方向,这似乎很麻烦。最终从任何

  4. ruby-on-rails - 渲染另一个 Controller 的 View - 2

    我想要做的是有2个不同的Controller,client和test_client。客户端Controller已经构建,我想创建一个test_clientController,我可以使用它来玩弄客户端的UI并根据需要进行调整。我主要是想绕过我在客户端中内置的验证及其对加载数据的管理Controller的依赖。所以我希望test_clientController加载示例数据集,然后呈现客户端Controller的索引View,以便我可以调整客户端UI。就是这样。我在test_clients索引方法中试过这个:classTestClientdefindexrender:template=>

  5. ruby-on-rails - 如果 Object::try 被发送到一个 nil 对象,为什么它会起作用? - 2

    如果您尝试在Ruby中的nil对象上调用方法,则会出现NoMethodError异常并显示消息:"undefinedmethod‘...’fornil:NilClass"然而,有一个tryRails中的方法,如果它被发送到一个nil对象,它只返回nil:require'rubygems'require'active_support/all'nil.try(:nonexisting_method)#noNoMethodErrorexceptionanymore那么try如何在内部工作以防止该异常? 最佳答案 像Ruby中的所有其他对象

  6. ruby - 为什么 SecureRandom.uuid 创建一个唯一的字符串? - 2

    关闭。这个问题需要detailsorclarity.它目前不接受答案。想改进这个问题吗?通过editingthispost添加细节并澄清问题.关闭8年前。Improvethisquestion为什么SecureRandom.uuid创建一个唯一的字符串?SecureRandom.uuid#=>"35cb4e30-54e1-49f9-b5ce-4134799eb2c0"SecureRandom.uuid方法创建的字符串从不重复?

  7. ruby-on-rails - Rails - 从另一个模型中创建一个模型的实例 - 2

    我有一个正在构建的应用程序,我需要一个模型来创建另一个模型的实例。我希望每辆车都有4个轮胎。汽车模型classCar轮胎模型classTire但是,在make_tires内部有一个错误,如果我为Tire尝试它,则没有用于创建或新建的activerecord方法。当我检查轮胎时,它没有这些方法。我该如何补救?错误是这样的:未定义的方法'create'forActiveRecord::AttributeMethods::Serialization::Tire::Module我测试了两个环境:测试和开发,它们都因相同的错误而失败。 最佳答案

  8. ruby - 用 Ruby 编写一个简单的网络服务器 - 2

    我想在Ruby中创建一个用于开发目的的极其简单的Web服务器(不,不想使用现成的解决方案)。代码如下:#!/usr/bin/rubyrequire'socket'server=TCPServer.new('127.0.0.1',8080)whileconnection=server.acceptheaders=[]length=0whileline=connection.getsheaders想法是从命令行运行这个脚本,提供另一个脚本,它将在其标准输入上获取请求,并在其标准输出上返回完整的响应。到目前为止一切顺利,但事实证明这真的很脆弱,因为它在第二个请求上中断并出现错误:/usr/b

  9. ruby - 一个 YAML 对象可以引用另一个吗? - 2

    我想让一个yaml对象引用另一个,如下所示:intro:"Hello,dearuser."registration:$introThanksforregistering!new_message:$introYouhaveanewmessage!上面的语法只是它如何工作的一个例子(这也是它在thiscpanmodule中的工作方式。)我正在使用标准的ruby​​yaml解析器。这可能吗? 最佳答案 一些yaml对象确实引用了其他对象:irb>require'yaml'#=>trueirb>str="hello"#=>"hello"ir

  10. ruby - Rails 关联 - 同一个类的多个 has_one 关系 - 2

    我的问题的一个例子是体育游戏。一场体育比赛有两支球队,一支主队和一支客队。我的事件记录模型如下:classTeam"Team"has_one:away_team,:class_name=>"Team"end我希望能够通过游戏访问一个团队,例如:Game.find(1).home_team但我收到一个单元化常量错误:Game::team。谁能告诉我我做错了什么?谢谢, 最佳答案 如果Gamehas_one:team那么Rails假设您的teams表有一个game_id列。不过,您想要的是games表有一个team_id列,在这种情况下

随机推荐