Getting the Gist of Markdown's Formatting Syntax
此页提供了 Markdown 的简单概念, 语法说明 页提供了完整详细的文档,说明了每项功能。但是 Markdown 其实很简单就可以上手,此页文档提供了一些范例,并且每个范例都会提供输出的 HTML 结果。
其实直接试试看也是一个很不错的方法, Dingus 是一个网页应用程序,你可以把自已编写的 Markdown 文档转成 XHTML。
段落、标题、区块代码
一个段落是由一个以上的连接的行句组成,而一个以上的空行则会划分出不同的段落(空行的定义是显示上看起来像是空行,就被视为空行,例如有一行只有空白和 tab,那该行也会被视为空行),一般的段落不需要用空白或换行缩进。
Markdown 支持两种标题的语法,Setext 和 atx 形式。Setext 形式是用底线的形式,利用 =
(最高阶标题)和 -
(第二阶标题),Atx 形式在行首插入 1 到 6 个 #
,对应到标题 1 到 6 阶。
区块引用则使用 email 形式的 '>
' 角括号。
Markdown 语法:
A First Level Header
====================
A Second Level Header
---------------------
Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.
The quick brown fox jumped over the lazy
dog's back.
### Header 3
> This is a blockquote.
>
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote
输出 HTML 为:
<h1>A First Level Header</h1>
<h2>A Second Level Header</h2>
<p>Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.</p>
<p>The quick brown fox jumped over the lazy
dog's back.</p>
<h3>Header 3</h3>
<blockquote>
<p>This is a blockquote.</p>
<p>This is the second paragraph in the blockquote.</p>
<h2>This is an H2 in a blockquote</h2>
</blockquote>
修辞和强调
Markdown 使用星号和底线来标记需要强调的区段。
Markdown 语法:
Some of these words *are emphasized*.
Some of these words _are emphasized also_.
Use two asterisks for **strong emphasis**.
Or, if you prefer, __use two underscores instead__.
输出 HTML 为:
<p>Some of these words <em>are emphasized</em>.
Some of these words <em>are emphasized also</em>.</p>
<p>Use two asterisks for <strong>strong emphasis</strong>.
Or, if you prefer, <strong>use two underscores instead</strong>.</p>
列表
无序列表使用星号、加号和减号来做为列表的项目标记,这些符号是都可以使用的,使用星号:
* Candy.
* Gum.
* Booze.
加号:
+ Candy.
+ Gum.
+ Booze.
和减号
- Candy.
- Gum.
- Booze.
都会输出 HTML 为:
<ul>
<li>Candy.</li>
<li>Gum.</li>
<li>Booze.</li>
</ul>
有序的列表则是使用一般的数字接着一个英文句点作为项目标记:
1. Red
2. Green
3. Blue
输出 HTML 为:
<ol>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ol>
如果你在项目之间插入空行,那项目的内容会用 <p>
包起来,你也可以在一个项目内放上多个段落,只要在它前面缩排 4 个空白或 1 个 tab 。
* A list item.
With multiple paragraphs.
* Another item in the list.
输出 HTML 为:
<ul>
<li><p>A list item.</p>
<p>With multiple paragraphs.</p></li>
<li><p>Another item in the list.</p></li>
</ul>
链接
Markdown 支援两种形式的链接语法: 行内 和 参考 两种形式,两种都是使用角括号来把文字转成连结。
行内形式是直接在后面用括号直接接上链接:
This is an [example link](http://example.com/).
输出 HTML 为:
<p>This is an <a href="http://example.com/">
example link</a>.</p>
你也可以选择性的加上 title 属性:
This is an [example link](http://example.com/ "With a Title").
输出 HTML 为:
<p>This is an <a href="http://example.com/" title="With a Title">
example link</a>.</p>
参考形式的链接让你可以为链接定一个名称,之后你可以在文件的其他地方定义该链接的内容:
I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"
输出 HTML 为:
<p>I get 10 times more traffic from <a href="http://google.com/"
title="Google">Google</a> than from <a href="http://search.yahoo.com/"
title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"
title="MSN Search">MSN</a>.</p>
title 属性是选择性的,链接名称可以用字母、数字和空格,但是不分大小写:
I start my morning with a cup of coffee and
[The New York Times][NY Times].
[ny times]: http://www.nytimes.com/
输出 HTML 为:
<p>I start my morning with a cup of coffee and
<a href="http://www.nytimes.com/">The New York Times</a>.</p>
图片
图片的语法和链接很像。
行内形式(title 是选择性的):
![alt text](/path/to/img.jpg "Title")
参考形式:
![alt text][id]
[id]: /path/to/img.jpg "Title"
上面两种方法都会输出 HTML 为:
<img src="/path/to/img.jpg" alt="alt text" title="Title" />
代码
在一般的段落文字中,你可以使用反引号 `
来标记代码区段,区段内的 &
、<
和 >
都会被自动的转换成 HTML 实体,这项特性让你可以很容易的在代码区段内插入 HTML 码:
I strongly recommend against using any `<blink>` tags.
I wish SmartyPants used named entities like `—`
instead of decimal-encoded entites like `—`.
输出 HTML 为:
<p>I strongly recommend against using any
<code><blink></code> tags.</p>
<p>I wish SmartyPants used named entities like
<code>&mdash;</code> instead of decimal-encoded
entites like <code>&#8212;</code>.</p>
如果要建立一个已经格式化好的代码区块,只要每行都缩进 4 个空格或是一个 tab 就可以了,而 &
、<
和 >
也一样会自动转成 HTML 实体。
Markdown 语法:
If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:
<blockquote>
<p>For example.</p>
</blockquote>
输出 HTML 为:
<p>If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:</p>
<pre><code><blockquote>
<p>For example.</p>
</blockquote>
相关推荐
markdown
Magnet::Markdown::Filter::Sanitize : 白名单清理用户标记 HTML::Pipeline::Filter::ImageMaxWidthFilter :链接到大图像的全尺寸图像 Magnet::Markdown::Filter::Emoji : 隐藏 :emoji: 到 img 元素 安装 将此行...
MarkdownText-Jetpack撰写 ... implementation ' com.github.jeziellago:compose-markdown:0.1.0 ' } 如何使用 val markdown = """ # Sample * Markdown * [Link](https://example.com) ![Image](h
MarkdownMarkdown简易入门教程使用方式:点编辑README.md 文件就可以看到所有markdown格式,照着来用就行了 标题一标题二标题三标题四标题五标题六三空格+换行=换行 斜体粗体斜体加粗体中划线++下划线++==标记==...
Markdown语法指南向用户展示了如何利用这些简单的语法规范,快速高效地创建出既易于编写又易于阅读的文档。对于想要快速将纯文本转换为格式化内容的用户,Markdown提供了一种非常实用和便捷的方法。
Rust 的 Markdown 渲染,使用 。 这基本上是 Hoedown API 的一对一映射,添加了 Rust 语义。 如何使用它 extern crate "rust-markdown" as markdown; let renderer = markdown :: HtmlRenderer :: new (); let mut...
rmarkdown-book:R Markdown:The Definitive Guide(由Chapman&HallCRC于2018年7月出版)
link rel =" stylesheet " href =" ./node_modules/markdown-tip/dist/markdown-tip.css " />vuejs组件 npm i markdown-tip-vue import { MarkdownTip } from "markdown-tip-vue"app . component ( 'markdown-...
Qiita :: Markdown Qiita指定的降价处理器。 降价转换 消毒 代码和语言检测 任务列表 总目录 表情符号 语法高亮 提到 脚注 基本用法 Qiita :: Markdown :: Processor提供了markdown渲染逻辑。 processor = Qiita ...
运行composer require vtalbot/markdown:1.5 运行php artisan config:publish vtalbot/markdown 然后根据需要编辑app/config/packages/vtalbot/markdown config.php 。 将'VTalbot\Markdown\...
Sails 博客 — Markdown 一个简单的 Sails 应用程序,它处理views/blog/article/下的 markdown 文件并将它们显示为博客文章。 这些帖子遵循标准格式: 文件名用作 URL slug,因此位于views/blog/article/sample-...
降价 用于Go的markdown解析器库。 用于为供电。 主要特点 ... 例如,如果您尝试将某些Markdown包装在div以进行样式设置: ...Ethereal Markdown解析div的文本,让您在通常HTML中混合Markdown: <div style="floa
MarkDown是世界上最优美最简洁的写博客的语言,全部用法汇总如下,请慢用!! Markdowm语法001:标题 Markdowm语法002:引用 Markdown语法003:斜体和粗体、红色显示及其他字体颜色 Markdown语法004:链接和图片 ...
请使用自己,已支持markdown。 2018-01-10 降价促销中JavaScript代码。 之前/之后 用法 yarn global add prettier-markdown npm install [-g] prettier-markdown 命令行界面 使用此脚本通过CLI运行prettier-...
如图解释:down_arrow:[google](#text2)可以看到我们使用的是小写,如果我们首字母使用大写[google](# Text2)即便是id地址的确是这么写的也是无法成功运行[markdown](#markdown)图片引用使用 ! [] ( )表格使用| file ...
产品特点理解多种文档样式(Sphinx,Google,Pydoc-Markdown) 支持赋值文档字符串( #:语句前的块或语句后的字符串文字) 将引用链接到其他已记录的API对象[WIP] , 和集成安装从PyPI安装Pydoc-Markdown: $ pipx ...
帮助 $ markdown -hUsage of markdown: -index string Index (or default) markdown file name (default "README.md") -listen string Interface:port to listen on (default ":8080")本地建筑如果您碰巧想在本
Markdown Parser和HTML Renderer for Go 软件包github.com/gomarkdown/markdown是一个非常快速的Go库,用于解析文档并将其呈现为HTML。 它速度很快,并支持常见扩展。API文件: :顶级软件包 :定义解析的markdown...
Jekyll-包含Markdown :memo: 轻松包含markdown文件,无需插件