草庐IT

Markdown 基本语法

lio_zero 2023-10-07 原文

简介

  • Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。
  • Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  • Markdown 编写的文档后缀为 .md, .markdown。

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如：GitHub、简书、reddit、知乎等。

本文使用 Typora 编写，它支持 MacOS 、Windows、Linux 平台，且包含多种主题，编辑后直接渲染出效果。支持导出 HTML、PDF、Word、图片等多种类型文件。

Tips：本文 markdown 语法在简书渲染有一些问题。可以下载 markdown 编辑器或在线编辑器进行学习。

以下内容参考 Markdown Guide 进行整理。

标题

# h1
## h2
### h3
#### h4
##### h5
###### h6

Header 1
========

Header 2
--------

效果：

标题

为了不影响排版，这里使用图片。

强调

*italic*
_italic_
**bold**
__bold__
`code`

效果：

italic
italic
bold
bold
code

列表

无序列表使用星号（*****）、加号（+）或是减号（-）作为列表标记

* Item 1
* Item 2

+ Item 1
+ Item 2

- Item 1
- Item 2

效果：

  • Item 1
  • Item 2
  • Item 1
  • Item 2
  • Item 1
  • Item 2

有序列表使用数字并加上 . 号来表示

1. Item 1
2. Item 2

效果：

  1. Item 1
  2. Item 2

列表嵌套

- Item 1
  - Item 1

效果：

  • Item 1
    • Item 1

待办事宜 Todo 列表

- [ ] Update the website
- [x] Write the press release

效果：

任务列表

这里在简书的渲染效果有问题，直接贴图片

链接

链接使用方法如下：

[Link name](path)

<path>

效果：

link

https://www.jianshu.com/u/3f644e66afa3

添加标题

[Link name](https://www.jianshu.com/u/3f644e66afa3 "title")

鼠标悬停链接上，查看效果：

我的简书

其他操作

通过变量来设置一个链接，变量赋值在文档末尾进行：

[lio][blog]
[blog]: https://www.jianshu.com/u/3f644e66afa3

效果：

通过变量来设置一个链接

简书编辑器所呈现的效果跟 typora 不一样，这里直接贴图片

图片

![Image alt text](/path/to/img.jpg)
显示图片

添加标题

![Image alt text](img.jpg "title")
添加标题

直接使用 <img /> 标签

<img src="path" />

代码

使用 ``` 包裹一段代码，并指定一种语言（也可以不指定）

代码

效果：

code fences

console.log('代码块')

区块引用

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

> 这是一个区块引用

效果：

这是一个区块引用

另外区块是可以嵌套的，一个 > 符号是最外层，两个 > 符号是第一层嵌套，以此类推

> 最外层
> > 第一层嵌套

效果：

最外层

第一层嵌套

分割线

使用三个以上的星号、减号、底线生成一个分隔线

----

****

___

效果：

删除线

使用两个波浪线 ~~ 来添加删除线

~~该内容已不再最新版本中使用~~

效果：

该内容已不再最新版本中使用

下划线

<u>带下划线文本</u>

效果：

<u>带下划线文本</u>

脚注

脚注是对文本的补充说明。

一段文字[^info]

效果：

脚注

内容目录

[TOC]

内容目录

这里在简书的渲染效果有问题，直接贴图片

表格

Markdown 制作表格使用 | 来分隔不同的单元格，使用 - 来分隔表头和其他行。

| Column 1 Heading | Column 2 Heading |
| ---------------- | ---------------- |
| Some content     | Other content    |

Column 1 Heading | Column 2 Heading
--- | ---
Some content | Other content

效果：

Column 1 Heading Column 2 Heading
Some content Other content
Column 1 Heading Column 2 Heading
Some content Other content

对齐方式：

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。
| Column 1 Heading | Column 2 Heading | Column 2 Heading |
| :---------------- | :----------------: | ----------------: |
| Some content     | Other content    | Other content |

效果：

Column 1 Heading Column 2 Heading Column 2 Heading
Some content Other content Other content

使用表情符号短代码?

使用开始和结束与冒号 :，并包括表情符号的名称。

Gone camping! :tent: Be back soon.

That is so funny! :joy:

效果：

Gone camping! ⛺️ Be back soon.

That is so funny! ?

你可以在下面这些网站上找到所有可用的 Emoji：

更多资料

Typora 画流程图、时序图(顺序图)、甘特图 来自菜鸟教程的 Markdown 高级技巧中的一篇笔记

本文首发 blog，如果喜欢或者有所启发，欢迎 Star，对作者也是一种鼓励。

Markdown基本sectionstrongcode

有关Markdown 基本语法的更多相关文章

  1. ruby - 树顶语法无限循环 - 2

    我脑子里浮现出一些关于一种新编程语言的想法，所以我想我会尝试实现它。一位friend建议我尝试使用Treetop(Rubygem)来创建一个解析器。Treetop的文档很少，我以前从未做过这种事情。我的解析器表现得好像有一个无限循环，但没有堆栈跟踪；事实证明很难追踪到。有人可以指出入门级解析/AST指南的方向吗？我真的需要一些列出规则、常见用法等的东西来使用像Treetop这样的工具。我的语法分析器在GitHub上，以防有人希望帮助我改进它。class{initialize=lambda(name){receiver.name=name}greet=lambda{IO.puts("He

  2. ruby-on-rails - 使用 Sublime Text 3 突出显示 HTML 背景语法中的 ERB？ - 2

    所以我在关注Railscast，我注意到在html.erb文件中，ruby代码有一个微弱的背景高亮效果，以区别于其他代码HTML文档。我知道Ryan使用TextMate。我正在使用SublimeText3。我怎样才能达到同样的效果？谢谢! 最佳答案 为SublimeText安装ERB包。假设您安装了SublimeText包管理器*，只需点击cmd+shift+P即可获得命令菜单，然后键入installpackage并选择PackageControl:InstallPackage获取包管理器菜单。在该菜单中，键入ERB并在看到包时选择

  3. ruby - 覆盖相似的方法，更短的语法 - 2

    在Ruby类中，我重写了三个方法，并且在每个方法中，我基本上做同样的事情:classExampleClassdefconfirmation_required?is_allowed&&superenddefpostpone_email_change?is_allowed&&superenddefreconfirmation_required?is_allowed&&superendend有更简洁的语法吗？如何缩短代码？ 最佳答案 如何使用别名？classExampleClassdefconfirmation_required?is_a

  4. ruby 语法糖 : dealing with nils - 2

    可能已经问过了，但我找不到它。这里有2个常见的情况(对我来说，在编程Rails时......)用ruby​​编写是令人沮丧的:"astring".match(/abc(.+)abc/)[1]在这种情况下，我得到一个错误，因为字符串不匹配，因此在nil上调用[]运算符。我想找到的是比以下内容更好的替代方法:temp="astring".match(/abc(.+)abc/);temp.nil??nil:temp[1]简而言之，如果不匹配，则简单地返回nil而不会出错第二种情况是这样的:var=something.very.long.and.tedious.to.writevar=some

  5. ruby - Ruby 语法糖有 "rules"吗？ - 2

    我正在学习Ruby的基础知识(刚刚开始)，我遇到了Hash.[]method.它被引入a=["foo",1,"bar",2]=>["foo",1,"bar",2]Hash[*a]=>{"foo"=>1,"bar"=>2}稍加思索，我发现Hash[*a]等同于Hash.[](*a)或Hash.[]*一个。我的问题是为什么会这样。是什么让您将*a放在方括号内，是否有某种规则可以在何时何地使用“it”？编辑:我的措辞似乎造成了一些困惑。我不是在问数组扩展。我明白了。我的问题基本上是:如果[]是方法名称，为什么可以将参数放在括号内？这看起来几乎——但不完全是——就像说如果你有一个方法Foo.d

  6. Unity 热更新技术 | （三） Lua语言基本介绍及下载安装 - 2

    ?博客主页：https://xiaoy.blog.csdn.net?本文由呆呆敲代码的小Y原创，首发于CSDN??学习专栏推荐：Unity系统学习专栏?游戏制作专栏推荐：游戏制作?Unity实战100例专栏推荐：Unity实战100例教程?欢迎点赞?收藏⭐留言?如有错误敬请指正！?未来很长，值得我们全力奔赴更美好的生活✨------------------❤️分割线❤️-------------------------

  7. 计算机毕业设计ssm+vue基本微信小程序的小学生兴趣延时班预约小程序 - 2

    项目介绍随着我国经济迅速发展,人们对手机的需求越来越大,各种手机软件也都在被广泛应用,但是对于手机进行数据信息管理,对于手机的各种软件也是备受用户的喜爱小学生兴趣延时班预约小程序的设计与开发被用户普遍使用,为方便用户能够可以随时进行小学生兴趣延时班预约小程序的设计与开发的数据信息管理,特开发了小程序的设计与开发的管理系统。小学生兴趣延时班预约小程序的设计与开发的开发利用现有的成熟技术参考,以源代码为模板,分析功能调整与小学生兴趣延时班预约小程序的设计与开发的实际需求相结合,讨论了小学生兴趣延时班预约小程序的设计与开发的使用。开发环境开发说明：前端使用微信微信小程序开发工具：后端使用ssm：VU

  8. ruby - 如何让Ruby捕获线程中的语法错误 - 2

    我正在尝试使用ruby​​编写一个双线程客户端，一个线程从套接字读取数据并将其打印出来，另一个线程读取本地数据并将其发送到远程服务器。我发现的问题是Ruby似乎无法捕获线程内的错误，这是一个示例:#!/usr/bin/rubyThread.new{loop{$stdout.puts"hi"abc.putsefsleep1}}loop{sleep1}显然，如果我在线程外键入abc.putsef，代码将永远不会运行，因为Ruby将报告“undefinedvariableabc”。但是，如果它在一个线程内，则没有错误报告。我的问题是，如何让Ruby捕获这样的错误？或者至少，报告线程中的错误？

  9. ruby -::在 Ruby 语法中是什么意思？ - 2

    这个问题在这里已经有了答案:WhatisRuby'sdouble-colon`::`?(12个答案)关闭8年前。什么是::？@song||=::TwelveDaysSong.new

  10. ruby-on-rails - 使用 HTTParty 的非常基本的 Rails 4.1 API 调用 - 2

    Rails相对较新。我正在尝试调用一个API，它应该向我返回一个唯一的URL。我的应用程序中捆绑了HTTParty。我已经创建了一个UniqueNumberController，并且我已经阅读了几个HTTParty指南，直到我想要什么，但也许我只是有点迷路，真的不知道该怎么做。基本上，我需要做的就是调用API，获取它返回的URL，然后将该URL插入到用户的数据库中。谁能给我指出正确的方向或与我分享一些代码？ 最佳答案 假设API为JSON格式并返回如下数据:{"url":"http://example.com/unique-url"

随机推荐