Skip to content
Open
Show file tree
Hide file tree
Changes from 5 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/twenty-hotels-unite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@gitbook/integration-scarf-gitbook': major
---

Adding the scarf integration to GitBook
107 changes: 106 additions & 1 deletion bun.lock

Large diffs are not rendered by default.

Binary file added integrations/scarf/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.
Binary file added integrations/scarf/assets/scarf-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions integrations/scarf/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: scarf-gitbook
title: Scarf
icon: ./assets/icon.png
previewImages:
- ./assets/scarf-preview.png
description: Connect your GitBook site to Scarf
externalLinks:
- label: Website
url: https://about.scarf.sh/
visibility: public
script: ./src/index.ts
# The following scope(s) are available only to GitBook Staff
# See https://developer.gitbook.com/integrations/configurations#scopes
scopes:
- site:script:inject
organization: gitbook
contentSecurityPolicy:
script-src: static.scarf.sh
summary: |
# Overview
Scarf helps you understand how your documentation is being used, and by which companies. Scarf is privacy conscious, and approved in most major OSS foundations.

# How it works
This integration will automatically add your Scarf pixel to the page.

# Configure
Find your tracking pixel's pixel ID from inside the pixel snippet url. Find the query param: `pxid`

categories:
- analytics
configurations:
site:
properties:
pixel_id:
type: string
title: Pixel ID
description: The id of your tracking pixel.
required:
- pixel_id
target: site
Loading
Loading