Fuchsia.dev 支持本指南中所述的 Markdown 元素。
块引用
Markdown 使用大于字符 (>
) 将文本呈现为块引用
(即引用文字)。
Markdown
This is a Markdown paragraph.
> This is a blockquote with two paragraphs. The first line of a blockquote
> paragraph has to have a greater-than character (`>`), but for readability
> in the source file, add a greater-than character to every subsequent line
> of the paragraph like this example. Though this isn't a requirement as
> shown in the second blockquote paragraph below.
>
> This is a second blockquote paragraph that only has a greater-than
character (`>`) for the first line. Donec sit amet nisl. Aliquam semper
ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus
adipiscing. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec,
fringilla in, laoreet vitae, risus.
已渲染
这是一个 Markdown 段落。
这是包含两个段落的块引用。块引用的第一行 段落必须包含大于字符 (
>
);但是为了提高可读性 在源文件中,在后续每一行中添加大于号字符 如本例所示不过,这并不是强制性要求 如下面的第二段引用文字所示。这是第二个引用段落,其中仅含有大于号 字符 (
>
)。Donec sit amet nisl.阿里夸姆·森珀尔 (Aliquam Semper) ipsum sit amet velit。Suspendisse id sem consectetuer libero luctus adipiscing。Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
代码块
代码块用于提供程序化示例或标记源代码。内容 不会像普通 Markdown 段落一样进行解析,而是按照写入的内容进行呈现。
您可以使用代码块来指定 编程语言 来呈现代码,以便突出显示。
三个反引号前后都需要空白行
(```
)。反引号不会在最终输出中呈现。
不过,代码块内的空白行会在最终输出中呈现。
Markdown
Example 1: Uses Java syntax highlighting ```java public class Hello { public static void main(String arg[]) { System.out.println("Hello."); } } ``` Example 2: Prevents syntax highlighting ```none {:.devsite-disable-click-to-copy} Some pseudo-code doesn't need syntax highlighting. ``` Example 3: Includes a replacement variable ```none {:.devsite-disable-click-to-copy} Hello, my name is {{ '<var>' }}your-name{{ '</var>' }}. ```
生成的 HTML
<p>Example 1: Uses Java syntax highlighting</p>
<pre class="prettyprint lang-java"><code>public class Hello {<br/>public
static void main(String arg[]) {<br/>System.out.println("Hello.");<br/>}
<br/>}<br/></code></pre>
<p>Example 2: Prevents syntax highlighting</p>
<pre class="click-to-copy"><code><br/><p>Some pseudo-code doesn't need
syntax highlighting.</p><br/>
</code></pre>
<p>Example 3: Includes a replacement variable</p>
<pre class="no-prettyprint"><code><br/><p>Hello, my name is <var>your-name</var>.
</p><br/></code></pre>
已渲染
示例 1:使用 Java 语法突出显示
public class Hello {
public static void main(String arg[]) {
System.out.println("Hello.");
}
}
示例 2:防止语法突出显示
Some pseudo-code doesn't need syntax highlighting.
示例 3:包含替换变量
Hello, my name is your-name.
在代码块内使用可替换的变量
如需在代码块中使用 <var>
标记,请使用 Jinja 表达式括号,如下所示:
{{ '<var>' }}PORT{{ '</var>' }}
上面的示例呈现以下内容:
PORT
评论
Fuchsia.dev 支持 Markdown 和 HTML 中的单行和多行注释。 这些评论不会显示在已发布的页面上。这些注释可用于提醒 贡献者(如果您的文档包含 includecode 或 MathJax)。
单行注释
多行注释
如需在 fuchsia.dev 上使用多行注释,请执行以下操作:
每行用 {# ... #}
换行。这适用于 HTML 和 Markdown:
{% verbatim %} {# I wonder how drivers are doing? #} {# I hear they are awesome! #}
自定义属性
通过 Fuchsia.dev,您可以设置自定义 HTML 属性
(例如 class
、id
或 attribute='value'
)。
支持的 Markdown 元素
以下元素支持自定义属性:
- 代码 span
- 代码块
- 标题
- 链接
- 列表
- 段落
- 表格和多行表格
格式
语法 | 说明 |
---|---|
{ 和} |
自定义属性的开头和结尾。 |
: |
对于 fuchsia.dev 中的 Markdown 自定义属性而言是必需的。 |
. |
句后字词 (. ) 设置元素的 class 。 |
# |
经过哈希处理的单词 (# ) 设置元素的 id 。 |
attribute='value'
|
设置元素的属性名称和值对;使用 空格来分隔成对。 |
Markdown
This is a Markdown paragraph.
{:.customClass #custom_id attribute='value'}
生成的 HTML
<p class="customClass" id="custom_id" attribute="value">This is a Markdown paragraph.</p>
定义列表
若要在 Markdown 中创建定义列表,请将术语在一行中列出,然后
在每个定义之前,在定义下方新一行添加一个英文冒号 (:
)。
Markdown
Apple
: A fruit
: A tech company
Orange
: A citrus fruit
A definition can also contain other block or inline elements. This is a
paragraph within the same definition as "A citrus fruit". Elements
within must be indented four spaces to be recognized as part of the
preceding definition.
: A color
生成的 HTML
<dl>
<dt>Apple</dt>
<dd>A fruit</dd>
<dd>A tech company</dd>
<dt>Orange</dt>
<dd>
<p>A citrus fruit</p>
<p>
A definition can also contain other block or inline elements. This is
a paragraph within the same definition as "A citrus fruit". Elements
within must be indented four spaces to be recognized as part of the
preceding definition.
</p>
</dd>
<dd>
<p>A color</p>
</dd>
</dl>
已渲染
- Apple
- 一颗水果
- 科技公司
- 橙色
一颗柑橘类水果
定义还可以包含其他块或内嵌元素。这是一个 段落与“柑橘类水果”的定义相同。Elements 内的四个空格,才能被识别为 。
一种颜色
强调效果和重点
Markdown 使用星号 (*
) 和下划线 (_
) 进行强调和强格式设置。
强调效果
以星号 (*
) 或下划线 (_
) 表示的文本为特定文本提供斜体样式。
Markdown
*single asterisks*
_single underscores_
supercali*fragilistic*expialidocious
supercali_fragilistic_expialidocious // won't format
生成的 HTML
<em>single asterisks</em>
<em>single underscores</em>
supercali<em>fragilistic</em>expialidocious
supercali_fragilistic_expialidocious
已渲染
单个星号
单个下划线
超级脆弱的幻想
supercali_fragilistic_expialidocious
极佳
双星号 (**
) 或下划线 (__
) 文本为特定文本提供粗体样式。
Markdown
**double asterisks**
__double underscores__
supercali**fragilistic**expialidocious
supercali__fragilistic__expialidocious
生成的 HTML
<strong>double asterisks</strong>
<strong>double underscores</strong>
supercali<strong>fragilistic</strong>expialidocious
supercali<strong>fragilistic</strong>expialidocious
已渲染
双星号
双下划线
超级脆弱的幻想
超级脆弱的幻想
转义
在 Markdown 中,某些字符采用的是预留语法。若要使用特殊字符, 使用反斜杠转义 (\) 显示以下文字字符:
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark
脚注
脚注是一种用于添加附加内容或补充内容的实用工具 同时又不会干扰网页的正常显示语法类似于 参考链接:
In the main text, include a label[^1] that starts with a caret.
[^1]: The footnote content goes here.
[^2]: Longer footnote content can be span multiple lines
by indenting the continuation 4 spaces.
脚注标签可以是任意字符串,只要它以
脱字符号 ^
。
标题
Markdown 支持在以 @ 开头使用 1 到 6 个哈希字符 (#
) 作为 atx 样式的标题
行,对应于标题级别 1 到 6。
Markdown
# This is an H1
## This is an H2
###### This is an H6
已渲染
这是 1 级标题
这是下半年
这是 H6
标头 ID
Fuchsia.dev 支持为每个标头使用自定义 HTML id
属性。如果
您想替换默认的 id
,请添加
自定义属性
{#user_defined_name}
。
Markdown
# Working with contacts {#working-with-contacts}
## Contact Entry
### Contacts are working
生成的 HTML
<h1 id="working-with-contacts">Working with contacts</h1>
<h2 id="contact-entry">Contact Entry</h2>
<h3 id="contacts-are-working">Contacts are working</h3>
目录
对于每个二级和三级标题,fuchsia.dev 会自动生成
网页的目录 (TOC)。要在目录中隐藏标题,请将
自定义属性
{:.hide-from-toc}
。
Markdown
## Hidden in TOC {:.hide-from-toc} // try to find it!
已渲染
隐藏在 TOC 中
水平规则
Markdown 支持在水平规则标记 (<hr>
) 中放置三个或更多个
连字符、星号或下划线。
执行下列各项操作会生成一条水平规则:
* * *
***
*****
- - -
---------------------------------------
图片
Markdown 使用的图片语法 ,支持两种样式:内联和引用。
每个图片都具有以下属性:
- 起始感叹号:
!
。 - 一组方括号,包含
alt
属性文本。 - 一对圆括号,其中包含图片的网址或路径,以及
用双引号或单引号括起来的可选
title
属性。 - 使用自定义属性语法
{: .my-custom-css-class}
的一组可选类
内嵌语法
以下是有效的内嵌图片语法:
![Alt text](/docs/images/benchmarking/test_suite_example.png)
![Alt text](/docs/images/benchmarking/test_suite_example.png "Optional title")
![Alt text](/docs/images/benchmarking/test_suite_example.png "Optional title"){: .my-custom-css-class}
引用语法
以下是引用样式的图片语法:
![Alt text][{{ '' }}ID{{ '' }}]
其中, {{ '' }}ID{{ '' }} 是定义的图片引用的名称。 图片引用使用与链接引用相同的语法进行定义:
{% verbatim %}[ID]: docs/images/benchmarking/test_suite_example.png "Optional title attribute"
自定义语法
您可以使用以下语法指定 Markdown 图片的宽度:
![Alt text](/docs/images/benchmarking/test_suite_example.png){: width="123"}
包含代码
includecode
标记包含来自其他文件的文本区域,尤其是源代码区域。
此类代码还可以在文字中生成可下载的文件,而不会包含
文本。
您可以使用此标记将一部分源代码插入到文档中,并维护该文档 以可运行文件的形式运行
gerrit_repo+path
参数是指托管在 Gerrit 或 Git 上的代码库和路径。
repo
的格式为 instance or repository
,而 path
的格式为 path/to/file
。
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" %}
包含文件的一部分
您可以通过以下三种方式指定要包含的文件区域:区域标记、正则表达式和缩进块。
区域标记
区域标记允许您在源文件中添加几行,用于表示 以及标记名称
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" region_tag="consts" %}
渲染时间:
const BOARD_SIZE uint8 = 9; const NAME string = "Tic-Tac-Toe";
正则表达式
您还可以使用正则表达式通过 regexp
参数来定义要提取的区域。
例如:
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" regexp="WRITE = 0b010;" %}
渲染时间:
WRITE = 0b010;
该模式使用 Python 正则表达式语法。如需更多信息 请参阅官方 Python 文档。
缩进块
您可以添加来自函数或类定义的代码,而无需定义区域标记。
使用 indented_block
参数:
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" indented_block="type User" %}
渲染时间:
type User = table { 1: age uint8; 2: name string:MAX_STRING_LENGTH; };
该模式使用 Python 正则表达式语法。如需了解详情,请参阅官方 Python 文档。
参数
以下是 includecode
的可选参数:
Markdown
参数 | |
---|---|
highlight |
可选 您可以使用 highlight 参数来吸引用户注意代码的特定部分。
使用逗号分隔值来指示要突出显示的行。行号为
而不是整个文件。
示例 {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" region_tag="bits" highlight="2,3,4" %}
|
adjust_indentation |
可选 默认情况下, includecode 返回源代码的指定部分,
包括空格。您可以使用
adjust_indentation 选项。
adjust_indentation 采用两个可能的值:
<ph type="x-smartling-placeholder">
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" region_tag="bits" adjust_indentation="-2" %}
|
html_escape |
可选 默认情况下, includecode 会对所有代码进行 HTML 转义。
您可以将 html_escape 设置为 False 以取消转义 HTML。
示例 {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/echo.test.fidl" region_tag="launcher" html_escape="False" %}
|
exclude_regexp |
可选 您可以根据正则表达式移除某些行。在删除评论或其他 。您无法使用多行正则表达式。 示例 {% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" region_tag="bits" exclude_regexp="READ" %}
|
已渲染
参数 | |
---|---|
highlight |
highlight="2,3,4" 之前:
bits FileMode : uint16 { READ = 0b001; WRITE = 0b010; EXECUTE = 0b100; }; highlight="2,3,4" 之后:
bits FileMode : uint16 { READ = 0b001; WRITE = 0b010; EXECUTE = 0b100; }; |
adjust_indentation |
adjust_indentation="-2" 之前:
bits FileMode : uint16 { READ = 0b001; WRITE = 0b010; EXECUTE = 0b100; }; adjust_indentation="-2" 之后:
bits FileMode : uint16 { READ = 0b001; WRITE = 0b010; EXECUTE = 0b100; }; |
html_escape |
html_escape="False" 之前:
MAX_STRING_LENGTH echo_prefix, request<Echo> request); html_escape="True" 之后:
MAX_STRING_LENGTH echo_prefix, request request); |
exclude_regexp |
exclude_regexp="READ" 之前:
bits FileMode : uint16 { READ = 0b001; WRITE = 0b010; EXECUTE = 0b100; }; exclude_regexp="READ" 之后:
bits FileMode : uint16 { WRITE = 0b010; EXECUTE = 0b100; }; |
包含 Markdown fragment
您可以将 Markdown 文件添加到当前 Markdown 文件中,以便使用
包含所需文件路径的 << >>
指令。路径必须相对于
当前 .md 源文件 - 请勿使用绝对路径。<<>>指令是块指令
因此必须单独占据一行
例如,如果当前文件 en/time-travel/example.md
想要包含
en/time-travel/_samples/_sample.md
时,该文件将指定:
<<_samples/_sample.md>>
内嵌代码
您可以使用反引号将文本换行,指示 Markdown 段落中的代码
引号 (`
)。
Markdown
Use the `printf()` function. Code for the `printf()` function is located in the `system\ ` directory.
This sentence has inline ` {code} ` with a lot of spaces but none are rendered.
生成的 HTML
<p>Use the <code>printf()</code> function. Code for the <code>printf()</code>
function is located in the <code>system\</code> directory.</p>
<p>This sentence has inline <code>{code}</code>with a lot of spaces but none
are rendered.</p>
已渲染
使用 printf()
函数。printf()
函数的代码位于
system\
目录中。
这句话的内嵌{code}
包含大量空格,但没有呈现。
内嵌 HTML
但是,Markdown 语法无法提供 HTML 的全部功能 Markdown 支持内嵌 HTML。您可以将文本封装在 HTML 中 元素标记,例如:
Markdown
This sentence is in Markdown with a <b>bold inline HTML tag</b>.
已渲染
这个句子使用 Markdown,并带有粗体内嵌 HTML 标记。
链接
Fuchsia.dev 支持三种样式的链接:内嵌、引用和外部。
在所有样式中,链接文字都由 []
(方括号)分隔。
内嵌链接
要创建内嵌链接,请立即使用一对圆括号 位于链接文字的右方括号后面。在圆括号内: 将链接指向的网址以及可选的 链接的标题(用引号括起来)。例如:
Markdown
This is [an example](https://fuchsia.dev/ "Title") inline link.
[This link](https://fuchsia.dev/) has no title attribute.
生成的 HTML
<p>This is <a href="https://fuchsia.dev/" title="Title">
an example</a> inline link.</p>
<p><a href="fuchsia.dev">This link</a> has no
title attribute.</p>
已渲染
这是<ph type="x-smartling-placeholder"></ph> 一个示例内嵌链接。
此链接包含 title 属性。
如果您引用的是本地资源(例如源代码树中的文件),则可以 使用相对路径。有关示例,请参阅文档自述文件。
参考链接
引用式链接使用另一方括号,括在 您可以使用标签来标识链接:
This is [an example][id] reference-style link.
您可以选择使用空格来分隔两对括号:
This is [an example] [id] reference-style link.
然后,在文档底部定义文档底部的链接, 一行:
[id]: https://{{example_url}}/ "Optional Title Here"
外部链接
您可以将链接指向外部网站,方法是将
{: .external}
添加到语法中。例如:
See the [official documentation](https://my_external_website){: .external} for details.
指向 Fuchsia 源代码或 Fuchsia 更改的链接不属于外部链接。
链接语法
无论您通过何种方式在内容中创建 Markdown 链接,都可以链接到各种 Fuchsia.dev 中的内容类型:
由贡献者创建的内容(位于 Fuchsia 源代码树的
//docs
目录中)。示例:这是一个指向
//docs/get-started/learn-fuchsia.md
:[Learn Fuchsia](/docs/get-started/learn-fuchsia.md)
fuchsia.dev/reference 等自动生成的内容不会 存在于 Fuchsia 源代码树中。
示例:这是一个指向
fuchsia.bluetooth
生成了 API 参考文档:[`fuchsia.bluetooth`](https://fuchsia.dev/reference/fidl/fuchsia.bluetooth)
Fuchsia 还在
//docs/reference/
目录。 您可以使用 Fuchsia 源代码树内容语法来链接此类内容。指向网址的链接。这些类型的链接必须标记为外部。
示例:以下是指向
google.com
的链接:[`google.com`](https://google.com){: .external}
列表
使用 Markdown 语法,您可以轻松创建项目符号列表或编号列表。
这通常称为无序(即项目符号)或有序
(即编号)列表,因为它们引用了生成的 (<ul>
) 和 (<ol>
) 列表
HTML 标记。
无序列表
无序列表可以使用星号 (*
)、加号 (+
) 或短划线 (-
) 作为列表
标记。无论您使用哪种标记,该列表都会呈现相同的效果。
Markdown
This is a Markdown paragraph:
// required blank line
* Red
* Green
* Blue
This is another Markdown paragraph:
// required blank line
+ Red
+ Green
+ Blue
This is yet another Markdown paragraph:
// required blank line
- Red
- Green
- Blue
生成的 HTML
<p>This is a Markdown paragraph:</p>
<ul>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ul>
<p>This is another Markdown paragraph:</p>
<ul>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ul>
<p>This is yet another Markdown paragraph:</p>
<ul>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ul>
已渲染
以下是一个 Markdown 段落:
- 红色
- 绿色
- 蓝色
这是另一个 Markdown 段落:
- 红色
- 绿色
- 蓝色
这是另一个 Markdown 段落:
- 红色
- 绿色
- 蓝色
多级无序列表
您可以在以下位置使用星号 (*
)、加号 (+
) 或短划线 (-
) 作为列表标记
多级无序列表。二级标记必须以 开头,
至少四个空格,并在每个级别保持一致。请参见下面的示例:
Markdown
This is a Markdown paragraph:
// required blank line before parent list
* Bird
* Celtics
* Retired
* Larry // extra space; not consistent w/ "Celtics"
* Magic
* Lakers
生成的 HTML
<p>This is a Markdown paragraph:</p>
<ul>
<li>Bird
<ul>
<li>Celtics</li>
<li>Retired</li>
<ul>
<li>Larry</li>
</ul>
</ul>
</li>
<li>Magic
<ul>
<li>Lakers</li>
</ul>
</li>
</ul>
已渲染
以下是一个 Markdown 段落:
- 波导
<ph type="x-smartling-placeholder">
- </ph>
- 凯尔特人
- 已退休
<ph type="x-smartling-placeholder">
- </ph>
- Larry
- 魔术
<ph type="x-smartling-placeholder">
- </ph>
- 湖人
有序列表
有序列表在列表项之前使用数字和英文句点。您可以定义自己的序数
编号,或使用 1.
自动编号。请参见下面的示例:
Markdown
This is a Markdown paragraph:
// required blank line
1. Bird // recommended numbering
1. McHale
1. Parish
This is another Markdown paragraph:
// required blank line
1. Bird // sequential numbering is allowed,
2. McHale // but not recommended
3. Parish
This is yet another Markdown paragraph:
// required blank line
3. Bird // non-sequential numbering is allowed,
1. McHale // but not recommended
8. Parish
生成的 HTML
<p>This is a Markdown paragraph:</p>
<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>
<p>This is another Markdown paragraph:</p>
<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>
<p>This is yet another Markdown paragraph:</p>
<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>
已渲染
以下是一个 Markdown 段落:
- 鸟
- McHale
- 教区
这是另一个 Markdown 段落:
- 鸟
- McHale
- 教区
这是另一个 Markdown 段落:
- 鸟
- McHale
- 教区
多级有序列表
您可以创建多级有序列表;第二级标记的前面必须至少有四个空格。
Markdown
1. Bird
1. Lakers
1. McHale
1. Celtics
生成的 HTML
<ol>
<li>Bird
<ol>
<li>Lakers</li>
</ol>
</li>
<li>McHale
<ol>
<li>Celtics</li>
</ol>
</li>
</ol>
已渲染
- 波导
<ph type="x-smartling-placeholder">
- </ph>
- 湖人
- McHale
<ph type="x-smartling-placeholder">
- </ph>
- 凯尔特人
MathJax
借助 <devsite-mathjax>
自定义元素,您可以用
fuchsia.dev 上的内容(使用 MathJax 2.7)。MathJax 利用 LaTeX 语法创建
。如需了解详情,请参阅 LaTeX 语法指南。
用法
要在文档中使用 MathJax,您必须在文档中加入一次自定义元素:
{# To see the fully rendered MathJax equations on this page,
see the published page at https://fuchsia.dev/<PATH_TO_YOUR_DOCUMENT>#}
<devsite-mathjax config="TeX-AMS-MML_SVG"></devsite-mathjax>
添加该自定义元素后,您可以在 $$
block or $
inline.
Standalone block
Markdown
<!-- <devsite-mathjax config="TeX-AMS-MML_SVG"></devsite-mathjax> -->
<div>
$$
R_{\mu\nu}-\frac{1}{2}Rg_{\mu\nu}+\Lambda{g_{\mu\nu}} = \frac{8\pi{G}}{c^4}{T_{\mu\nu}}
$$
</div>
Rendered
Inline
Markdown
<!--Included only one time previously-->
<devsite-mathjax config="TeX-AMS-MML_SVG"></devsite-mathjax>
The area of a circle can be computed using the equation $ A = \pi{r^2} $,
where $ r $ is the radius of the circle, and $ \pi $ is the mathematical
constant that is approximately equal to 3.14159.
Rendered
The area of a circle can be computed using the equation $ A = \pi{r^2} $,
where $ r $ is the radius of the circle, and $ \pi $ is the mathematical
constant that is approximately equal to 3.14159.
Paragraphs
A paragraph is simply one or more consecutive lines of text, separated
by one or more blank lines. (A blank line is any line that looks like a
blank line -- a line containing nothing but spaces or tabs is considered
blank.) You do not need to indent normal paragraphs with spaces or tabs.
Tables
Markdown makes it easy to format tables with pipes (|
) and hyphens (-
).
Deliminate text with pipes to create columns; a header row is defined when
the following row has at least three hyphens for each column header.
Markdown
Lesson | Description
------------------------ | ---------------------------------------
What is Fuchsia? | An open source effort to create a production-grade operating system
What is FIDL? | Fuchsia Interface Definition Language
Getting Started | Download the Fuchsia source code
Generated HTML
<table>
<thead>
<tr>
<th>Lesson</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>What is Fuchsia?</td>
<td>An open source effort to create a production-grade operating system</td>
</tr>
<tr>
<td>What is FIDL?</td>
<td>Fuchsia Interface Definition Language</td>
</tr>
<tr>
<td>Getting Started</td>
<td>Download the Fuchsia source code</td>
</tr>
</tbody>
</table>
Rendered
Lesson
Description
What is Fuchsia?
An open source effort to create a production-grade operating system
What is FIDL?
Fuchsia Interface Definition Language
Getting Started
Download the Fuchsia source code
Formatting text in a table
You can use Markdown syntax to format text within a table (that is, *emphasis*
,
**strong**
, `code`
). To align text within a column, add a colon
:
in the dash ---
row to indicate direction (that is, left
, center
, right
) as
in the example below:
Markdown
Left-aligned | Center-aligned | Right-aligned
:--- | :---: | ---:
info | info | info
more info | more info | more info
even *more* info | some `code` | **not** code
Rendered
Left-aligned
Center-aligned
Right-aligned
info
info
info
more info
more info
more info
even more info
some code
not code
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-10-11。