#电子书
电子书由一个文件夹组成,如您正在浏览的 Markdown Writer 文档。文件夹内所有静态资源(图片)都可复用,
所有文档可以用链接语法互相跳转(注意需要使用相对路径)。并配备搜索功能,搜索功能以锚点的方式展示和跳转结果。
不建议超过2级文档目录,过多的层级会影响浏览体验。
搜索结果只会定位在h2,h3锚点上,也只有h2,h3锚点会生成右侧内容导航。
搜索结果只会定位在h2,h3锚点上,也只有h2,h3锚点会生成右侧内容导航。
#快捷方式
- 在需要再创建电子书的目录下创建一个文件夹
.ebook
- 在
.ebook
文件夹下创建一个config.json
文件 - 在
config.json
文件中配置如下字段
{ "bookName": "演示文档", "path": "demo", "expandAll": true, "ignorePaths": [ "assets" ] }
字段说明
bookName
必选,电子书名,30个字符以内。path
必选,决定了url当中的访问路径。2-30个字符之间,由小写英文字母数字 和 - 符号组成,- 符号不能出现在首尾。ignorePaths
可选,忽略文件夹,比如存放静态文件或其他文件的文件夹,同步时将绕过。expandAll
可选,默认目录不展开,设为true后所有目录默认展开。
直接在文件夹下,点击右键,可看到
同步电子书
菜单选项,点击同步将会根据目录与markdown文件生成对应章节。

#定制方式
快捷方式是根据目录结构直接生成,并不能根据需要调整目录结构与排序,很多情况下我们需要手动指定目录结构与排列顺序。
只需在配置文件中加入如下字段:
{ "bookName": "演示文档", "path": "demo", "chapters": [ { "name": "介绍", "path": "introduction", "group": true, "expand": true, "children": [ { "name": "关于Markdown Writer", "path": "about", "src": "introduction/about.md" }, { "name": "快速开始", "path": "getting-start", "src": "introduction/getting-start.md" } ] }, ... ] }
chapters字段说明
name
必选 章节名称。path
必选 用于显示在浏览器url中,如上配置中,关于Markdown Writer
访问链接为/[空间]/book/demo/introduction/about
。(最好由英文字母数字和 - 符号组成,无需填写完整路径)group
可选 代表当前选项是一个目录。expand
可选 当前目录默认展开。src
可选 指向真实的文档文件地址,地址相对于电子书根目录,请不要以/
开头,请勿漏写.md
文件后缀。
然后同步电子书,即可看到自定义的章节目录。