https://github.com/snowdreams1006/gitbook-plugin-copyright
基于Gitbook实现的版权保护插件,用于复制内容时追加版本信息以及文章末尾添加版权小尾巴
https://github.com/snowdreams1006/gitbook-plugin-copyright
copyright gitbook-plugin gitbook-plugin-copyright website wechat
Last synced: 11 months ago
JSON representation
基于Gitbook实现的版权保护插件,用于复制内容时追加版本信息以及文章末尾添加版权小尾巴
- Host: GitHub
- URL: https://github.com/snowdreams1006/gitbook-plugin-copyright
- Owner: snowdreams1006
- License: mit
- Created: 2019-10-03T05:26:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-17T01:32:59.000Z (almost 2 years ago)
- Last Synced: 2025-07-03T09:54:35.445Z (11 months ago)
- Topics: copyright, gitbook-plugin, gitbook-plugin-copyright, website, wechat
- Language: JavaScript
- Homepage: https://snowdreams1006.github.io/gitbook-plugin-copyright/
- Size: 5.53 MB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gitbook-plugin-copyright 👋
[](https://www.npmjs.com/package/gitbook-plugin-copyright)
[](https://www.npmjs.com/package/gitbook-plugin-copyright)
[](https://github.com/snowdreams1006/gitbook-plugin-copyright#readme)
[](https://github.com/snowdreams1006/gitbook-plugin-copyright/graphs/commit-activity)
[](https://github.com/snowdreams1006/gitbook-plugin-copyright/blob/master/LICENSE)
[](https://github.com/snowdreams1006)
[](https://snowdreams1006.github.io/snowdreams1006-wechat-public.jpeg)
> `gitbook-plugin-copyright` 是基于Gitbook实现的**版权保护插件**,用于复制内容时**追加版权信息**以及文章末尾**添加版权小尾巴**.
## 特色
- 支持复制内容**自动追加**版本保护信息
- 支持文章末尾**自动生成**版本保护尾巴
- 支持自定义小尾巴**版权保护图片**
- 支持 `Gitbook` **多语言环境**
## ✨ 示例
```json
{
"plugins": ["copyright"],
"pluginsConfig": {
"copyright": {
"site": "https://snowdreams1006.github.io/gitbook-plugin-copyright",
"author": "雪之梦技术驿站",
"website": "雪之梦技术驿站",
"image": "https://snowdreams1006.github.io/snowdreams1006-wechat-open.png",
"copyProtect": false
}
}
}
```
## 🚀 用法
### Step #1 - 更新 `book.json` 配置文件
1. 在 `book.json` 配置文件中,添加 `copyright` 到 `plugins` 列表.
2. 在 `book.json` 配置文件中,配置 `pluginsConfig` 对象.
#### 单语言版简单示例 `book.json`
```json
{
"plugins": ["copyright"],
"pluginsConfig": {
"copyright": {
"site": "https://snowdreams1006.github.io/gitbook-plugin-copyright",
"author": "雪之梦技术驿站",
"website": "雪之梦技术驿站",
"image": "https://snowdreams1006.github.io/snowdreams1006-wechat-open.png",
"copyProtect": false
}
}
}
```
#### 多语言版简单示例 `book.json`
```json
{
"plugins": ["copyright"],
"pluginsConfig": {
"copyright": {
"site": "https://snowdreams1006.github.io/gitbook-plugin-copyright",
"author": {
"en": "snowdreams1006",
"zh": "雪之梦技术驿站"
},
"website": {
"en": "snowdreams1006's Gitbook",
"zh": "雪之梦技术驿站"
},
"image": {
"en": "https://img.shields.io/badge/github-snowdreams1006-brightgreen.svg",
"zh": "https://snowdreams1006.github.io/snowdreams1006-wechat-open.png"
},
"copyProtect": false
}
}
}
```
其中,配置参数含义如下:
- `site` : [必选]部署网站基本路径
- `author` : [必选]作者信息
- `website` : [必选]网站名称
- `image` : [可选]版权保护图片
- `copyProtect` : [可选]复制内容是否追加版权保护信息
### Step #2 - 运行 gitbook 相关命令
- 运行 `gitbook install` 命令安装到本地项目
```bash
$ gitbook install
```
- 运行 `gitbook build` 命令构建本地项目或者 `gitbook serve` 启动本地服务.
```bash
$ gitbook build
```
或者
```bash
$ gitbook serve
```
## 作者
👤 **snowdreams1006**
- Github: [@snowdreams1006](https://github.com/snowdreams1006)
- Email: [snowdreams1006@163.com](mailto:snowdreams1006@163.com)
## 支持
如果本项目对你有所帮助,欢迎 ⭐️ [gitbook-plugin-copyright](https://github.com/snowdreams1006/gitbook-plugin-copyright) 项目,感谢你的支持与认可!
## 📝 版权
Copyright © 2019 [snowdreams1006](https://github.com/snowdreams1006).
This project is [MIT](https://github.com/snowdreams1006/gitbook-plugin-copyright/blob/master/LICENSE) licensed.