UNPKG

1.84 kBMarkdownView Raw
1## 下载:
2从 NPM 中安装
3
4``` bash
5npm install ydoc-theme-[name] --save
6```
7
8### 配置
9在配置文件里添加配置,如果不配置此项,则为默认主题。
10
11```json
12{
13 "theme": "library",
14 ...
15}
16```
17
18## 主题介绍
19
20### 默认主题
21
22简洁高效,匠心独运。
23
24去除冗余的设计元素,直达目标,极致简约。
25
26![](http://ojk406wln.bkt.clouddn.com/ydoc-default.png)
27
28### library
29
30————你见过凌晨四点图书馆的灯光吗?
31
32————我见过,那时我正在debug。。
33
34![](http://ojk406wln.bkt.clouddn.com/ydoc-library.png)
35
36### ocean
37
38海洋——浩瀚无边,求索——永无止境。
39
40沉默之中亦有波澜,这是每个程序员内心深处的情愫。
41
42![](http://ojk406wln.bkt.clouddn.com/ydoc-ocean.png)
43
44### travel
45
46背上行囊,忘记烦恼,
47
48在清晨的阳光中,踏上一次探索的旅行。
49
50![](http://ojk406wln.bkt.clouddn.com/ydoc-travel.png)
51
52## 开发主题
53每一个插件都是一个 npm 模块,命名规则为 `ydoc-theme-<name>`,比如 `ydoc-theme-ocean`
54最简单的方法是使用npm安装默认主题的模块 `ydoc-theme-default`,根据自己的设计在文件中修改或添加内容。
55``` bash
56npm install ydoc-theme-default
57```
58
59<h3 style="font-weight: normal"> 配置 </h3>
60修改或新建 `ydoc-theme-<name>` 目录中的 `theme.config` 文件。
61```json
62{
63 "css": ["./default.css"],
64 "js": ["./default.js"]
65}
66```
67<h3 style="font-weight: normal"> 自定义主题 </h3>
68在目录下新建或修改default.css、default.js即可开发主题。
69主题中的文件会被引入到页面中,配置的优先级关系是 `插件(insertCSS/insertJS)配置 > 主题配置 > ydoc基础配置`
70
71<h3 style="font-weight: normal"> 发布 </h3>
72编辑 package.json 中的模块名称、版本号等信息,执行 npm publish 即可。