Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Syft integration #502

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/short-carrots-hug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@gitbook/integration-syft': patch
---

Adding the first version
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ It also hosts the default integrations provided by the GitBook team:
- [`sentry`](./integrations/sentry/)
- [`segment`](./integrations/segment/)
- [`slack`](./integrations/slack/)
- [`syft`](./integrations/syft/)
- [`toucantoco`](./integrations/toucantoco/)

## Contributing
Expand Down
3 changes: 3 additions & 0 deletions integrations/syft/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["@gitbook/eslint-config/integration"]
}
Binary file added integrations/syft/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions integrations/syft/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: syft
title: Syft
organization: 5R4Iu5dnFmc1wfhsNVVT
visibility: unlisted
description: 'Syft helps you get leads from your GitBook traffic.'
icon: ./assets/icon.png
summary: |
# Overview
This integration allows you to use Syft on your GitBook site.

# How it works
The integration injects the Syft script on your page, using the configured Syft key. The script collects visitor session and makes it available in the Syft dashboard.

# Configure
Install the integration on the GitBook space.
Locate the Syft key you want to use, which is available in the Syft snippet. https://app.syftdata.com/dashboard/settings/snippets
categories:
- analytics
externalLinks:
- label: Dashboard
url: https://app.syftdata.com/
- label: Documentation
url: https://docs.getsyft.app/
- label: Website
url: https://getsyft.app/
script: src/index.tsx
scopes:
- space:script:inject
- site:script:inject
secrets: {}
contentSecurityPolicy:
script-src: cdn.syftdata.com https://*.syftdata.com;
configurations:
space:
properties:
syft_key:
type: string
title: API Key
description: Available here https://app.syftdata.com/dashboard/settings/snippets
required:
- syft_key
site:
properties:
syft_key:
type: string
title: API Key
description: Available here https://app.syftdata.com/dashboard/settings/snippets
required:
- syft_key
Loading