https://github.com/papercups-io/docusaurus-plugin

Papercups plugin for Docusaurus
https://github.com/papercups-io/docusaurus-plugin

chat docusaurus papercups

Last synced: 5 months ago
JSON representation

Papercups plugin for Docusaurus

• Host: GitHub
• URL: https://github.com/papercups-io/docusaurus-plugin
• Owner: papercups-io
• License: mit
• Created: 2021-06-07T20:04:41.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-10T14:57:56.000Z (almost 4 years ago)
• Last Synced: 2024-12-19T23:46:10.503Z (6 months ago)
• Topics: chat, docusaurus, papercups
• Language: JavaScript
• Homepage:
• Size: 9.77 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @papercups-io/docusaurus-plugin

[![NPM](https://img.shields.io/npm/v/@papercups-io/docusaurus-plugin.svg)](https://www.npmjs.com/package/@papercups-io/docusaurus-plugin)

This plugins enable usage of the Papercups chat widget on Docusaurus powered websites.

## Install

```

npm install --save @papercups-io/docusaurus

```

## Usage

1. Sign up at https://app.papercups.io/register to get your account token. Your account token is what you will use to pass in as the accountId prop below.

2. Configure the plugin in `docusaurus.config.js`:

```

// docusaurus.config.js

module.exports = {

  plugins: [

    [

      "@papercups-io/docusaurus-plugin",

      {

        /* REQUIRED */

        // Pass in your Papercups account token here after signing up

        accountId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx',

        /* OPTIONAL */

        title: 'Welcome to Papercups!',

        subtitle: 'Ask us anything in the chat window below 😊',

        newMessagePlaceholder: 'Start typing...',

        primaryColor: '#13c2c2',

        // Initial message that new users will see.

        greeting: 'Hi there! How can I help you?',

        // Used only when self-hosting Papercups. Otherwise leave it empty.

        baseUrl: 'https://app.papercups.io',

        // Add this if you want to require the customer to enter

        // their email before being able to send you a message

        requireEmailUpfront: true,

        // Add this if you want to indicate when you/your agents

        // are online or offline to your customers

        showAgentAvailability: true,

      },

    ],

  ],

};

```

3. If you are hot reloading the code you might need to refresh the page for the widget to show up.

See our [demo](http://app.papercups.io/demo) or our [main repo](https://github.com/papercups-io/papercups)