jekyll-deskcrew 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +40 -2
- data/lib/jekyll-deskcrew/version.rb +1 -1
- metadata +14 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 44fd8a65cacde55e0afbe9f18581d955ed61b943be90c26d37a8d956f2e11fe7
|
|
4
|
+
data.tar.gz: b064cb91ea0bbd4b42e9dc9325d317ea6694e21df7d6cee56da6a7e66312eb4d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5347bffa99a9fb8bd217ce9ac5111a89c4381356feb271df925457612205e750c69ea044d8fbd1473154fec8b6eb11ceba0aef8c96953ab732fd22e2664d8be9
|
|
7
|
+
data.tar.gz: 2867a61dd0572c0fa037e3dc6fdd5a5415ab16d0142ca6b2702f68ed83819dbf64cd43eeca7b982af076e5ec8bbfd95a5566d167b9d14b457551e21bdd7cc46b
|
data/README.md
CHANGED
|
@@ -2,9 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**Live chat, an AI support chatbot and a help center for Jekyll, from one line in `_config.yml`.** jekyll-deskcrew adds the [DeskCrew](https://deskcrew.io) support widget to every page and post of a Jekyll site: visitors chat with an AI that answers from your knowledge base, anything it cannot answer becomes a ticket, and a human approves every reply before it sends. No layout edits, no `_includes` changes, no JavaScript to write.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Works with any theme (Minima, Just the Docs, Chirpy, al-folio, Beautiful Jekyll) and any host that runs plugins (Netlify, Cloudflare Pages, Vercel, GitHub Actions). Free plan, no credit card: https://deskcrew.io/signup
|
|
8
|
+
|
|
9
|
+
## Use it for
|
|
10
|
+
|
|
11
|
+
- **Live chat on a Jekyll blog or documentation site** without touching the theme.
|
|
12
|
+
- **An AI chatbot for docs**: it answers from the help articles you publish and hands off to a person when it is unsure.
|
|
13
|
+
- **A contact form replacement**: visitors ask in the widget, you get a ticket, no form backend or serverless function to host.
|
|
14
|
+
- **A help center for a static product site** that stays on your domain.
|
|
15
|
+
- **Replacing a paid chat widget** (Tawk.to, Crisp, Intercom, Zendesk) with one that starts free and never sends a reply you did not approve.
|
|
8
16
|
|
|
9
17
|
## Install
|
|
10
18
|
|
|
@@ -35,6 +43,36 @@ Build the site. The launcher appears on every generated HTML page. GitHub Pages
|
|
|
35
43
|
|
|
36
44
|
A `post_render` hook injects one `<script>` tag before `</body>` on every page and document with an `.html` output. Every value from `_config.yml` is validated and HTML-escaped first; a missing or malformed key means nothing is injected, and a page that already carries the tag is never given a second one.
|
|
37
45
|
|
|
46
|
+
## FAQ
|
|
47
|
+
|
|
48
|
+
### How do I add live chat to a Jekyll site?
|
|
49
|
+
|
|
50
|
+
Add `jekyll-deskcrew` to the `:jekyll_plugins` group in your Gemfile, list it under `plugins:` in `_config.yml`, and put your widget key under `deskcrew:`. Build the site. Every generated page and post carries the chat bubble.
|
|
51
|
+
|
|
52
|
+
### Does it work on GitHub Pages?
|
|
53
|
+
|
|
54
|
+
GitHub Pages' built-in build only runs an allowlist of plugins, and this one is not on it. Two options: build with a GitHub Actions workflow (the standard `actions/jekyll-build-pages` or your own `jekyll build`) and deploy the output, or skip the plugin and paste the one-line widget snippet into `_includes/head.html` as described at https://deskcrew.io/integrations/jekyll. Netlify, Cloudflare Pages and Vercel run plugins as normal.
|
|
55
|
+
|
|
56
|
+
### Does it change my theme or layouts?
|
|
57
|
+
|
|
58
|
+
No. A `post_render` hook inserts one script tag before `</body>` on every HTML page and document. Your layouts, includes and CSS are untouched, and the widget renders inside a Shadow DOM so your styles and its styles never collide.
|
|
59
|
+
|
|
60
|
+
### Can I turn it off for some pages or in development?
|
|
61
|
+
|
|
62
|
+
Set `enabled: false` under `deskcrew:` in `_config.yml` to keep the plugin installed with the widget off. For per-environment control, keep a `_config.dev.yml` with `enabled: false` and pass it with `--config _config.yml,_config.dev.yml` when serving locally.
|
|
63
|
+
|
|
64
|
+
### Is the AI chatbot going to make things up?
|
|
65
|
+
|
|
66
|
+
It answers only from the knowledge base you publish on DeskCrew and says so when it does not know. Anything it cannot answer becomes a ticket, and a person approves every outbound reply.
|
|
67
|
+
|
|
68
|
+
### Is there a free plan?
|
|
69
|
+
|
|
70
|
+
Yes. The free plan includes the chat widget, ticketing, a public help center and a monthly AI answer allowance, with no credit card: https://deskcrew.io/pricing
|
|
71
|
+
|
|
72
|
+
### Which Jekyll versions are supported?
|
|
73
|
+
|
|
74
|
+
Jekyll 3.9 and 4.x on Ruby 2.7 or newer.
|
|
75
|
+
|
|
38
76
|
## What the plugin adds to your site
|
|
39
77
|
|
|
40
78
|
One script tag loading `https://deskcrew.io/desk.js` with your public widget key. The widget runs inside a Shadow DOM and does not touch your styles. Terms: https://deskcrew.io/terms. Privacy: https://deskcrew.io/privacy.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-deskcrew
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- DeskCrew
|
|
@@ -29,9 +29,14 @@ dependencies:
|
|
|
29
29
|
- - "<"
|
|
30
30
|
- !ruby/object:Gem::Version
|
|
31
31
|
version: '5'
|
|
32
|
-
description:
|
|
33
|
-
|
|
34
|
-
|
|
32
|
+
description: 'Add customer support to a Jekyll blog, docs site or product site: a
|
|
33
|
+
live chat widget, an AI chatbot that answers from your knowledge base, a public
|
|
34
|
+
help center, and support tickets with human-approved replies. The plugin injects
|
|
35
|
+
the DeskCrew widget before </body> on every generated page and post through a post_render
|
|
36
|
+
hook, configured entirely from _config.yml, no layout or include edits. Works with
|
|
37
|
+
Minima, Just the Docs, Chirpy, al-folio and any theme; builds on Netlify, Cloudflare
|
|
38
|
+
Pages, Vercel and GitHub Actions. Free plan, no credit card. An alternative to Tawk.to,
|
|
39
|
+
Crisp, Intercom or Disqus-style support widgets for static sites.'
|
|
35
40
|
email:
|
|
36
41
|
- support@deskcrew.io
|
|
37
42
|
executables: []
|
|
@@ -48,7 +53,9 @@ licenses:
|
|
|
48
53
|
- MIT
|
|
49
54
|
metadata:
|
|
50
55
|
homepage_uri: https://deskcrew.io/integrations/jekyll
|
|
51
|
-
|
|
56
|
+
documentation_uri: https://deskcrew.io/integrations/jekyll
|
|
57
|
+
source_code_uri: https://github.com/webmilmind1/jekyll-deskcrew
|
|
58
|
+
bug_tracker_uri: https://github.com/webmilmind1/jekyll-deskcrew/issues
|
|
52
59
|
rubygems_mfa_required: 'true'
|
|
53
60
|
rdoc_options: []
|
|
54
61
|
require_paths:
|
|
@@ -66,5 +73,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
66
73
|
requirements: []
|
|
67
74
|
rubygems_version: 3.6.9
|
|
68
75
|
specification_version: 4
|
|
69
|
-
summary:
|
|
76
|
+
summary: Live chat, AI support chatbot and help center widget for Jekyll sites (DeskCrew
|
|
77
|
+
plugin, one line in _config.yml, free plan).
|
|
70
78
|
test_files: []
|