文档章节

Markdown快速入门

老刘pro
 老刘pro
发布于 2017/05/12 22:49
字数 1207
阅读 6
收藏 0

Markdown 是一种轻量级标记语言,创始人为 John Gruber 和 Aaron Swartz。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的 XHTML/HTML 文档”

OSC 博客已支持使用Markdown书写,可以在发表博文的时候点编辑器右上方的切换按钮一键切换编辑器或者到 空间管理-博客管理-博客设置 处设置默认编辑器。

本文简单介绍下 Markdown 的基本语法,让初学者可以快速入门并使用这种标记语言。

标题

标题(h1~h6)可使用相应个数的#来生成,如下面的代码将会生成h3:

### this is a level-3 header ###

或者使用底线形式,利用=(最高阶标题)和-(第二阶标题):

This is an H1
=============

This is an H2
-------------

段落和换行

使用一个或多个 空行 分隔内容段来生成段落 (<p>)
在行末输入2个或以上 空格 再回车来生成换行(<br>)

强调

1个*或_包围起来的文字将会被<em>标签包围:

*single asterisks*

_single underscores_

2个*或_包围起来的文字将会被<strong>标签包围:

**double asterisks**

__double underscores__

注:如果你的 * 和 _ 两边都有空白的话,它们就只会被当成普通的符号。

分隔线

在一行内使用3个以上的*-或_来建立 分隔线 (<hr>),行内除此之外不能有其它内容:

* * *

***

*****

- - -

---------------------------------------

区块引用

使用>作为段落前缀来标识引用文字段落。这其实是 email 中标记引用文字的标准方式:

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> 
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
> id sem consectetuer libero luctus adipiscing.

列表

使用*+-来表示无序列表<ul>:

* Red
* Green
* Blue

使用数字紧跟一个 英文句点 .来表示有序列表ol:

1. Bird
2. McHale
3. Parish

代码

使用 反引号 (`)(在键盘上位于1的左边)把文字括起来来表示行内代码,这段文字将会被<code>标签包围:

Use the `printf()` function.

使用4个 空格 或1个 制表符 (Tab)缩进来表示代码区块,它们将被<pre>和<code>标签包裹起来,在代码区块里面的&<和>会自动转成 HTML 实体:

<div class="footer">
        &copy; 2004 Foo Corporation
    </div>

链接

行内式语法:

This is [an example](http://example.com/ "Title") inline link.

[This link](http://example.net/) has no title attribute.

参考式语法:

This is [an example][id] reference-style link.

  [id]: http://example.com/  "Optional Title Here"

注:下面的链接定义,你可以把它放到文章的任意位置。

自动链接:

<http://example.com/>

隐式链接标记:

I get 10 times more traffic from [Google][] than from
[Yahoo][] or [MSN][].

  [google]: http://google.com/        "Google"
  [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
  [msn]:    http://search.msn.com/    "MSN Search"

图片

图片的语法和链接比较相似,也有 行内式 和 参考式 两种。
行内式语法:

![Alt text](/path/to/img.jpg)

![Alt text](/path/to/img.jpg "Optional title")

参考式语法:

![Alt text][id]

  [id]: url/to/image  "Optional title attribute"

注:到目前为止, Markdown 还没有办法指定图片的宽高,如果你需要的话,你可以使用普通的<img>标签。

转义字符

可以利用反斜杠来插入一些在语法中有其它意义的符号:

\*literal asterisks\*

Markdown支持的转义字符列表:

\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号

其它

书写表格: Markdown 并没有提供表格语法,但你可以像写 HTML 那样使用标签来书写表格,但要注意 HTML 标签内的 Markdown 表达式将不会被解析。
代码高亮: 这不在Markdown支持的范围之内,OSC 的 Markdown 编辑器支持代码高亮,你可以在代码上方使用<!--lang: java-->或lang: java的形式来指定编程语言,这样文章在显示的时候会使用 SyntaxHighlighter 自动按照指定的语言进行语法着色。

Markdown资源

  1. Markdown 项目主页
  2. Markdown 语法说明(中文版)
  3. Markdown 工具:

暂时就这么多吧,欢迎大家继续补充!

© 著作权归作者所有

老刘pro
粉丝 1
博文 23
码字总数 14720
作品 0
葫芦岛
程序员
私信 提问

暂无文章

Mybatis Plus性能分析

一、配置 /** * 性能分析 * @return */@Bean@Profile({"dev","test"})public PerformanceInterceptor performanceInterceptor (){ PerformanceInterceptor performanceInterceptor......

一个yuanbeth
23分钟前
4
0
一次写shell脚本的经历记录——特殊字符惹的祸

本文首发于微信公众号“我的小碗汤”,扫码文末二维码即可关注,欢迎一起交流! redis在容器化的过程中,涉及到纵向扩pod实例cpu、内存以及redis实例的maxmemory值,statefulset管理的pod需要...

码农实战
26分钟前
4
0
为什么阿里巴巴Java开发手册中不建议在循环体中使用+进行字符串拼接?

之前在阅读《阿里巴巴Java开发手册》时,发现有一条是关于循环体中字符串拼接的建议,具体内容如下: 那么我们首先来用例子来看看在循环体中用 + 或者用 StringBuilder 进行字符串拼接的效率...

武培轩
39分钟前
6
0
队列-链式(c/c++实现)

队列是在线性表功能稍作修改形成的,在生活中排队是不能插队的吧,先排队先得到对待,慢来得排在最后面,这样来就形成了”先进先出“的队列。作用就是通过伟大的程序员来实现算法解决现实生活...

白客C
47分钟前
65
0
聊聊nacos的notifyConfigInfo

序 本文主要研究一下nacos的notifyConfigInfo CommunicationController nacos-1.1.3/config/src/main/java/com/alibaba/nacos/config/server/controller/CommunicationController.java @Cont......

go4it
昨天
6
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部