Schnack.js 开源项目教程

Schnack.js 开源项目教程

schnack 🗣️ Simple self-hosted node app for Disqus-like drop-in commenting on static websites 项目地址: https://gitcode.com/gh_mirrors/sc/schnack

1. 项目介绍

Schnack 是一个轻量级的自托管评论系统，它旨在为静态网站提供类似 Disqus 的评论功能。Schnack.js 以其小巧的体积（大约 8 KB）和开源、自托管的特点受到开发者的青睐。它不包含任何广告和跟踪功能，为用户提供了一个简洁、清爽的界面来管理和审核评论。此外，Schnack 通过 webpush 协议支持通知站点管理员有关新评论的审核请求。它还支持第三方认证，如 Github、Twitter、Google 和 Facebook，用户无需在您的系统上注册新账户。

2. 项目快速启动

在开始之前，请确保您的系统已经安装了 Node.js (版本 >= v8) 和 npm (版本 >= v6)。

1. 创建一个新的文件夹用于存放 Schnack，并切换到该文件夹：

   mkdir schnack
   cd schnack
   

2. 初始化 Schnack：

   如果当前文件夹中没有 schnack.json 文件，运行以下命令来复制默认配置文件并询问是否需要交互式配置服务器：

   npm init schnack
   

   或者，您可以直接编辑配置文件，参考配置章节。

3. 使用文本编辑器编辑 schnack.json，设置您的服务器配置。

4. 再次运行初始化命令来完成安装：

   npm init schnack
   

5. 启动服务器：

   npm start
   

   如果您想在本地主机上尝试 Schnack（无需认证），可以使用以下命令：

   npm start -- --dev
   

6. 在您的 HTML 页面中嵌入 Schnack：

   <div class="comments-go-here"></div>
   <script src="https://comments.example.com/embed.js" data-schnack-slug="post-slug" data-schnack-target=".comments-go-here"></script>
   

   或者以编程方式初始化 Schnack：

   <div class="comments-go-here"></div>
   <script src="http://comments.example.com/client.js"></script>
   <script>
     new Schnack({
       target: '.comments-go-here',
       slug: 'post-slug',
       host: 'http://comments.example.com'
     });
   </script>
   

3. 应用案例和最佳实践

• 案例一：在一个静态博客中嵌入 Schnack，为用户提供评论功能，同时保持网站的轻量级和简洁。
• 案例二：使用 Schnack 作为公司内部网站的评论系统，便于员工之间的交流与互动。

最佳实践：

• 使用 npm run dev 命令在本地开发环境中快速测试和调试。
• 通过添加 ssl 配置项到 schnack.json 文件中，为本地开发环境启用 HTTPS。

4. 典型生态项目

目前，Schnack 社区已经有了一些扩展插件，例如：

• @schnack/plugin-auth-github：用于集成 Github 认证。
• @schnack/plugin-auth-google：用于集成 Google 认证。
• @schnack/plugin-notify-slack：用于集成 Slack 通知。

您可以在 schnack.json 文件中配置这些插件，以扩展 Schnack 的功能。

以上就是关于 Schnack.js 的开源项目教程，希望对您有所帮助。

schnack 🗣️ Simple self-hosted node app for Disqus-like drop-in commenting on static websites 项目地址: https://gitcode.com/gh_mirrors/sc/schnack