gitbook-manifest.yaml

name: figma
title: Figma
icon: ./assets/icon.png
description: Embed Figma files and designs directly into GitBook pages.
previewImages:
    - ./assets/figma-preview.png
visibility: public
script: ./src/index.tsx
summary: |
    # Overview

    This integration embeds Figma artboards and files into GitBook documents, making it easy to find and view relevant design files whenever you need them. Never search through Figma, Slack, or emails to find design files again.

    # How it works

    Embedding Figma files into GitBook is simple - just paste a Figma link into the GitBook editor. The app will turn the link into an embed that shows the Figma file name along with an image snapshot of what the file looked like at the moment that you embedded it.

    When viewing an embed, click on the maximize button to preview the file in GitBook or on the file or artboard name to open it in Figma.

    # Configure

    GitBook admins can go to the integrations settings to connect your organization's Figma account to GitBook. Once enabled, the integration will work for all spaces where it's enabled in your organization.
scopes: []
blocks:
    - id: embed
      title: Figma
      description: Preview of a Figma file
      urlUnfurl:
          - https://www.figma.com/file/**
configurations:
    account:
        properties:
            oauth_credentials:
                type: button
                title: Connection
                description: Authorization between Figma and GitBook.
                button_text: Authorize
                callback_url: /oauth
        required:
            - oauth_credentials
secrets:
    CLIENT_ID: ${{ env.FIGMA_CLIENT_ID }}
    CLIENT_SECRET: ${{ env.FIGMA_CLIENT_SECRET }}