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