『书摘。』使用说明

五岳寻仙不辞远,一生好入名山游。 —— 唐代:李白《庐山谣寄卢侍御虚舟》

『书摘。』成立于2019年8月29日,目前收录了文学作品、影视作品、动漫、游戏以及网络上的好句。您可以将『书摘。』插件调用到您的网站中,也可以加入到我们,来为项目做出贡献。

license

sponsors

hits

code-size

stars

演示

快速开始

将『书摘。』插件调用到您的网站中,这非常简单,仅需要将下面的代码粘贴到您需要显示『书摘。』的页面中。

传统配置

更加轻量化。

1
<script src="https://cdn.jsdelivr.net/gh/Book-Excerpts/[email protected]/src/haoju.js"></script>
1
<div id="haoju" class="shuzhai"></div>
1
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/Book-Excerpts/[email protected]/src/css/shuzhai.css">

个性化配置

更加个性化。

您需要在网站根目录下新建一个名为shuzhai.config.js的文件,按照下面的格式来自主选择个性化功能,并在需要显示『书摘。』的页面调用。

注意:以下内容可能会随着版本更新有所变化,请以当前最新版本的配置文件示例为准。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
(function config(){

config = { // 参数配置区域:您可以到https://book.fly6022.fun/ 或 https://book-excerpts.github.io/ 来查看他们的具体含义及配置须知.

data: function(){

cdn = ["https://cdn.jsdelivr.net/gh/book-excerpts/haoju/src/haoju/8/8-fly6022.json"];

}, // 数据源CDN


settings: function(){ // 功能配置区域:以下是一些个性化功能,您可按需开启.

display_haojuid = true; // 是否显示好句ID

haoju_type = 8; // 好句类型

},

dev: function(){

debug = false; // 用于调试时排除错误,默认为false.

}

}})()

特性

  1. 场景丰富
    您几乎可以在任何地方使用它,无论是在Web网页中还是APP中。

  2. 轻量便捷
    采用Javascript + Ajax开发,免去后端配置。

  3. 多快好省
    约2KB大小的控制文件 + 存储在jsDelivr CDN上的JSON数据,在保证数据安全及数据量的条件下兼顾了访问速度。

许可证

『书摘。』好句插件开源基于 GPL V3.0 许可证. 须在许可证的要求下进行开发.

『书摘。』数据存储格式规范

说明

书摘的好句数据库是一个(组)JSON文件,因此,在存储它们时也应当遵循JSON语法.

本文章声明了书摘数据存储规范,供开发者参考.

注意:以下内容可能随版本更新而有改动,请以最新版本为准.

基本格式

以下是数据库文件格式的标准示例:

1
2
3
4
5
6
[{
"haoju": "内容",
"author": "作者",
"from": "《作品名称或来源》"
}
]

以下是一个实例:

1
2
3
4
5
6
[{
"haoju": "在这个吵得人分不清东南西北的世界里,我们手里所持有的干干净净的初衷,不多了,握好了,别丢了,明天还要赶很远的路.",
"author": "七堇年",
"from": "《灯下尘》"
}
]

文件命名

为了便于开发者管理,对好句数据文件的命名应当变得高效,因此对命名规则说明如下:

文件名称由自定义名称和扩展名构成,在这里,扩展名一律为.json.

对于自定义名称,遵循”<好句代号>-<Github用户名>”的格式:

好句代号

1
2
3
4
5
6
7
8
9
0. 文学类
1. 动漫类
2. 古代诗词类
3. 现代诗歌类
4. 网络文本类
5. 原创文本类
6. 游戏作品类
7. 影视作品类
8. 其它类型(综合)

Github用户名

即编辑该数据文件的开发者的Github用户名.

文件名示例

例如,由fly6022开发的好句数据文件,主要包含了动漫类文本,则命名为:

1
1-fly6022.json