summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-plugin-sharing/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/gitbook-plugin-sharing/README.md')
-rw-r--r--packages/gitbook-plugin-sharing/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/packages/gitbook-plugin-sharing/README.md b/packages/gitbook-plugin-sharing/README.md
new file mode 100644
index 0000000..28ae0d4
--- /dev/null
+++ b/packages/gitbook-plugin-sharing/README.md
@@ -0,0 +1,38 @@
+# plugin-sharing
+
+This plugin adds sharing buttons in the GitBook website toolbar to share book on social networks.
+
+### Disable this plugin
+
+This is a default plugin and it can be disabled using a `book.json` configuration:
+
+```
+{
+ plugins: ["-sharing"]
+}
+```
+
+### Configuration
+
+This plugin can be configured in the `book.json`:
+
+Default configuration is:
+
+```js
+{
+ "pluginsConfig": {
+ "sharing": {
+ "facebook": true,
+ "twitter": true,
+ "google": false,
+ "weibo": false,
+ "instapaper": false,
+ "vk": false,
+ "all": [
+ "facebook", "google", "twitter",
+ "weibo", "instapaper"
+ ]
+ }
+ }
+}
+```