https://github.com/talaxy009/gatsby-plugin-waline

A Gatsby plugin for Waline comment system
https://github.com/talaxy009/gatsby-plugin-waline

Last synced: 1 day ago
JSON representation

A Gatsby plugin for Waline comment system

• Host: GitHub
• URL: https://github.com/talaxy009/gatsby-plugin-waline
• Owner: Talaxy009
• License: mit
• Created: 2023-03-01T07:19:04.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-09T14:00:00.000Z (8 months ago)
• Last Synced: 2024-12-24T23:08:04.148Z (1 day ago)
• Language: JavaScript
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-zh.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gatsby-plugin-waline

[![npm version](https://badge.fury.io/js/gatsby-plugin-waline.svg)](https://badge.fury.io/js/gatsby-plugin-waline)

一个为 Gatsby 站点嵌入 [Waline](https://waline.js.org/) 评论系统的插件。

## ✨ 功能

本插件能帮你在你的站点更轻松地使用 Waline 评论。

- 使用 React Hooks API 对最新的 Waline 进行纯粹的封装

- 支持 Waline 的所有配置

- 由 TypeScript 编写

## 🚚 安装

```shell

npm install gatsby-plugin-waline

npm install -D @waline/client

```

或

```shell

yarn add gatsby-plugin-waline

yarn add -D @waline/client

```

本插件依赖 **React v16.8** 或更高版本。

## 🔦 使用方法

0. 查看 Waline [官方文档](https://waline.js.org/guide/get-started/) 以部署你的服务端。

1. 修改你的 gatsby-config.js 文件以启用本插件

    ```js

    // 你的 gatsby-config.js

    plugins: [

        {

            resolve: `gatsby-plugin-waline`,

            options: {

                // 插件配置

                serverURL: 'YOUR_SERVER_URL',

            },

        },

    ];

    ```

2. 在你的页面代码中使用 `` 组件

    ```jsx

    import React from 'react';

    import Waline from 'gatsby-plugin-waline';

    export default function Page({location}) {

        return (

            

                

            

        );

    }

    ```

    插件配置项和组件配置项是一样的。你可以把常用配置 (如 `serverURL`, `emoji`) 放在插件配置中，把为页面单独配置的选项 (如 `path`) 放在组件配置中。配置会被合并且来自组件的配置有更高的优先级。

3. 在你的 gatsby-browser.js 导入 CSS 文件

    ```jsx

    // 你的 gatsby-browser.js

    import '@waline/client/dist/waline.css';

    ```

    关于自定义样式的信息，详见：

在这之后，你应该能够在你的站点添加和查看评论了。

## 🔧 配置项

详见：