【格式指南】 Markdown 文档格式编辑指引

设备嵌入式开发产品技术讨论,包括TuyaOS、SDK、TuyaWind IDE及其他开发者工具等话题


Post Reply
york.wang
Posts: 50

码农发文必备工具, 格式化文档(Markdown), 代码语法高亮(Code), 图表(Mermaid) ,在 TuayOS论坛 齐活儿了。

格式化文档

以 Markdown 为基础生成的格式化文档。

标题

一般来说, 上一标题跟下一标题之前要留空行。

Code: Select all

# h1

## h2 Heading

### h3 Heading

#### h4 Heading

##### h5 Heading

###### h6 Heading

h1 Heading

h2 Heading

h3 Heading

h4 Heading

h5 Heading
h6 Heading

水平钱

Code: Select all

___

---

***



强调

Code: Select all

**粗体**

__粗体__

*斜体*

_斜体_

~~删除线~~

粗体

粗体

斜体

斜体

删除线

引用

Code: Select all

> 一次引用
>> 二次引用 
> > > 三次引用 

一次引用
二次引用
三次引用

列表

无序列表

Code: Select all

+ 用 +, - 或者 * 进行列表 
+ 一般两个空格缩进:
  - 新的主题:
    * 示例
    + 示例 
    - 示例 
+ 很简单吧
  • 用 +, - 或者 * 字符都可以
  • 一般两个空格缩进:
    • 新的主题:
    • 示例
    • 示例
    • 示例
  • 很简单吧

有序列表

Code: Select all

1. 示例
2. 示例
3. 示例
  1. 示例
  2. 示例
  3. 示例

Code: Select all

1. 示例
1. 示例
1. 示例
  1. 示例
  2. 示例
  3. 示例

以某一个数学为起始的列:

Code: Select all

57. foo
1. bar
  1. foo
  2. bar

带选择框列表

Code: Select all

- [x] 选择列表
    - [x] 选择列表
- [ ] 无选择列表
  • 选择列表
    • 选择列表
  • 无选择列表

下标

Code: Select all

H~2~O

H2O

底色强调

Code: Select all

`code`

表格

Code: Select all

左对齐表格
| Option | Description |
| ------ | ----------- |
| data   | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext    | extension to be used for dest files. |

右对齐表格
| Option | Description |
| ------:| -----------:|
| data   | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext    | extension to be used for dest files. |
| Option | Description |

左对齐表格

OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.

右对齐表格

OptionDescription
datapath to data files to supply the data that will be passed into templates.
engineengine to be used for processing templates. Handlebars is the default.
extextension to be used for dest files.
OptionDescription

链接

Code: Select all

[TuyaOS介绍](https://developer.tuya.com/cn/tuyaos)

TuyaOS介绍

JamesG
Posts: 33

Re: 【格式指南】 Markdown 文档格式编辑指引

h1 Heading 8-)

h2 Heading

h3 Heading

h4 Heading

h5 Heading
h6 Heading

test

Post Reply