1.0.0 • Published 10 months ago

gitbook-plugin-copyright v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
10 months ago

gitbook-plugin-copyright 👋

NPM Version NPM Download Documentation Maintenance License: MIT Github: snowdreams1006 微信公众号: 雪之梦技术驿站

gitbook-plugin-copyright 是基于Gitbook实现的版权保护插件,用于复制内容时追加版权信息以及文章末尾添加版权小尾巴.

特色

  • 支持复制内容自动追加版本保护信息
  • 支持文章末尾自动生成版本保护尾巴
  • 支持自定义小尾巴版权保护图片
  • 支持 Gitbook 多语言环境

✨ 示例

{
    "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 配置文件中,添加 copyrightplugins 列表.
  2. book.json 配置文件中,配置 pluginsConfig 对象.

单语言版简单示例 book.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

{
    "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 命令安装到本地项目
$ gitbook install
  • 运行 gitbook build 命令构建本地项目或者 gitbook serve 启动本地服务.
$ gitbook build

或者

$ gitbook serve

作者

👤 snowdreams1006

支持

如果本项目对你有所帮助,欢迎 ⭐️ gitbook-plugin-copyright 项目,感谢你的支持与认可!

snowdreams1006-wechat-donate.jpg

📝 版权

Copyright © 2019 snowdreams1006.

This project is MIT licensed.

1.0.0

10 months ago

0.4.3

10 months ago

0.4.2

10 months ago

0.4.1

5 years ago

0.4.0

5 years ago

0.3.3

6 years ago

0.3.2

6 years ago

0.3.1

6 years ago

0.3.0

6 years ago

0.2.4

6 years ago

0.2.3

6 years ago

0.2.2

6 years ago

0.2.1

6 years ago

0.2.0

6 years ago

0.1.0

6 years ago

0.0.8

6 years ago

0.0.7

6 years ago

0.0.6

6 years ago

0.0.5

6 years ago

0.0.4

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago

0.0.1

6 years ago