https://github.com/lorisleiva/vuepress-plugin-disqus

🔌 Register a global Disqus component to add to your layouts
https://github.com/lorisleiva/vuepress-plugin-disqus

Last synced: 2 months ago
JSON representation

🔌 Register a global Disqus component to add to your layouts

• Host: GitHub
• URL: https://github.com/lorisleiva/vuepress-plugin-disqus
• Owner: lorisleiva
• License: mit
• Created: 2019-02-04T18:15:40.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2020-12-03T11:54:03.000Z (about 4 years ago)
• Last Synced: 2024-10-12T01:28:51.656Z (3 months ago)
• Language: JavaScript
• Size: 7.81 KB
• Stars: 29
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vuepress Plugin Disqus

🔌 Register a global `` component to add to your layouts.

This plugins is a vuepress wrapper of [vue-disqus](https://github.com/ktquez/vue-disqus).

## Installation

```bash

npm i vuepress-plugin-disqus -D

```

## Register the plugin

```js

plugins: {

    'disqus': { /* options */ }

},

```

Please check out [Config](#config) for options.

Note that Vuepress allows multiple syntaxes to register plugins. See [Vuepress documentation on how to use a plugin](https://vuepress.vuejs.org/plugin/using-a-plugin.html) for more information.

## Use the Disqus component

This plugin present a out-of-box SSR-friendly component  - ``. Just put it wherever you like, and Disqus will be embedded in the right place. For example:

```html

  


    

    

    

  


```

Or you can simply put it in your `.md` file.

```markdown

## Hello VuePress

This is a demo.

```

You can use all the props and events defined by [vue-disqus](https://github.com/ktquez/vue-disqus).

Prop            | Data Type  | required  | Description

--------------- | ---------- | --------- | -----------

`shortname`     | String     | true      | Your disqus shortname.

`url`           | String     | false     | Your URL where Disqus is present

`title`         | String     | false     | Title that identifies the current page.

`identifier`    | String     | false     | The page's unique identifier

`sso_config`    | Object     | false     | Single sign-on (SSO)

`api_key`       | String     | false     | Your API key disqus

`remote_auth_s3`| String     | false     | implementation with Laravel/PHP

`language`      | String     | false     | Language overrides

## Config 

See the table above. All the props are also configuration options for this plugin. They'll be passed to every `Disqus` component. You're still able to override it by passing down props. Note that if you don't set language, it'll use VuePress's $lang as default language.

There's still one option available - `name` which specifies the name of the disqus component. Defaults to: `Disqus`.