Markdown 速查
Hexo-admonition
Hexo-admonition 遵循一种简单的语法:每个块都以 !!!
开头,然后是代表提示类型的关键字(type
)及标题(title
)。例如:
1 | !!! note Hexo-admonition 插件使用示例 |
在 Hexo 渲染前,将被转换成如下内容:
1 | <div class="admonition note "> |
最终呈现效果如下:
支持的类型
提示类型 type
将用作 CSS 类名称,暂支持如下类型:
note
info, todo
warning, attention, caution
error, failure, missing, fail
设置/隐藏标题
标题 title
是可选的,当未设置时,将以 type
作为默认值:
1 | !!! warning |
效果如下:
如果不想显示标题,可以将 title
设置为
""
:
1 | !!! Warning "" |
效果如下:
嵌套 markdown 标记
在 hexo-admonition
内部,还可以嵌套标准 Markdown
标签,例如:
1 | !!! note "嵌套链接及引用块" |
Guide
这是一篇讲解如何正确使用 Markdown 的排版示例,学会这个很有必要,能让你的文章有更佳清晰的排版。
引用文本:Markdown is a text formatting syntax inspired
语法指导
普通内容
这段内容展示了在内容里面一些小的格式,比如:
- 加粗 -
**加粗**
- 倾斜 -
*倾斜*
删除线-~~删除线~~
Code 标记
-`Code 标记`
- 超级链接 -
[超级链接](http://github.com)
- username@gmail.com -
[username@gmail.com](mailto:username@gmail.com)
大标题 - Heading 3
你可以选择使用 H2 至 H6,使用 ##(N) 打头,H1 不能使用,会自动转换成 H2。
NOTE: 别忘了 # 后面需要有空格!
Heading 4
Heading 5
Heading 6
图片
1 | ![alt 文本](http://image-path.png) |
代码块
普通
1 | *emphasize* **strong** |
语法高亮支持
如果在 ``` 后面更随语言名称,可以有语法高亮的效果哦,比如:
演示 Ruby 代码高亮
1 | class PostController < ApplicationController |
演示 Rails View 高亮
1 | <%= @posts.each do |post| %> |
演示 YAML 文件
1 | zh-CN: |
Tip: 语言名称支持下面这些:
ruby
,python
,js
,html
,erb
,css
,coffee
,bash
,json
,yml
,xml
...
有序、无序列表
无序列表
- Ruby
- Rails
- ActiveRecord
- Rails
- Go
- Gofmt
- Revel
- Node.js
- Koa
- Express
有序列表
- Node.js
- Express
- Koa
- Sails
- Ruby
- Rails
- Sinatra
- Go
表格
如果需要展示数据什么的,可以选择使用表格哦
header 1 | header 3 |
---|---|
cell 1 | cell 2 |
cell 3 | cell 4 |
cell 5 | cell 6 |
段落
留空白的换行,将会被自动转换成一个段落,会有一定的段落间距,便于阅读。
请注意后面 Markdown 源代码的换行留空情况。