UNPKG

ydoc/docs/documents/pages-custom.md

Version:

858 BMarkdownView Raw

1# 自定义页面
2
3YDoc 的页面可支持 .md、.jsx、.html 三种类型。我们推荐大部分的文档内容 __使用 markdown 编写__，少数个性化页面使用 html 或 jsx 实现。
4
5### Markdown 规则
6YDoc 会根据 markdown 内容获取网站标题和描述信息，如下所示，YDoc 会将当前页面标题设置为 “示例”， 页面描述信息设置为 “这是一个示例。”。
7
8```markdown
9# 示例
10这是一个示例。
11
12## 章节1
13
14## 章节2
15
16```
17
18### Html 规则
19YDoc 支持解析 .html 文件，你可以使用 html 所有特性高度自定义页面内容。
20
21### JSX 规则
22
23JSX 就是 Javascript 和 XML 结合的一种格式。React发明了JSX，利用HTML语法来创建虚拟DOM。
24
25Ydoc 使用了开源工具 [noox](https://github.com/suxiaoxin/noox)  解析 .jsx 文件，详细使用方法参考 [jsx](jsx.md)
26

1	`# 自定义页面`
2
3	`YDoc 的页面可支持 .md、.jsx、.html 三种类型。我们推荐大部分的文档内容 __使用 markdown 编写__，少数个性化页面使用 html 或 jsx 实现。`
4
5	`### Markdown 规则`
6	`YDoc 会根据 markdown 内容获取网站标题和描述信息，如下所示，YDoc 会将当前页面标题设置为 “示例”，页面描述信息设置为 “这是一个示例。”。`
7
8	```markdown
9	`# 示例`
10	`这是一个示例。`
11
12	`## 章节1`
13
14	`## 章节2`
15
16	```
17
18	`### Html 规则`
19	`YDoc 支持解析 .html 文件，你可以使用 html 所有特性高度自定义页面内容。`
20
21	`### JSX 规则`
22
23	`JSX 就是 Javascript 和 XML 结合的一种格式。React发明了JSX，利用HTML语法来创建虚拟DOM。`
24
25	`Ydoc 使用了开源工具 [noox](https://github.com/suxiaoxin/noox) 解析 .jsx 文件，详细使用方法参考 [jsx](jsx.md)`
26