FastComments.com

Add Comments to Your Eleventy (11ty) Site


Ово је званична Eleventy (11ty) библиотека за FastComments.

Уградите видгете за коментарисање уживо, ћаскање и рецензије у ваш Eleventy (11ty) сајт.

Репозиторијум

Погледајте на GitHub


Преглед уживо Internal Link

Да бисте видјели све shortcode-ове и flow-ове који се покрећу локално против јавног demo tenant-а, клонирајте репозиторијум и покрените:

cd example
npm install
npm start

Свака компонента има сопствену страницу у example/src/pages/ коју можете директно копирати у свој Eleventy сајт.

Инсталација Internal Link

npm install fastcomments-11ty

Брзи почетак Internal Link

Региструјте додатак у вашој Eleventy конфигурацији (.eleventy.js или eleventy.config.js):

const { fastcommentsPlugin } = require('fastcomments-11ty');

module.exports = function(eleventyConfig) {
    eleventyConfig.addPlugin(fastcommentsPlugin);
};

Или са ESM:

import { fastcommentsPlugin } from 'fastcomments-11ty';

export default function(eleventyConfig) {
    eleventyConfig.addPlugin(fastcommentsPlugin);
}

Затим користите кратке ознаке у вашим шаблонима. У Nunjucks (.njk):

{% fastcomments { tenantId: "demo" } %}

У Liquid (.liquid):

{% fastcomments tenantId: "demo" %}

Замените "demo" са вашим FastComments tenant ID.

Кратки кодови Internal Link

Кратки код Опис
fastcomments Видгет за коментаре са одговорима, гласањем и још много тога
fastcommentsCommentCount Приказује број коментара за страницу
fastcommentsImageChat Коментари за анотацију слика
fastcommentsLiveChat Видгет за чет уживо
fastcommentsCollabChat Колаборативно унутарлинерско коментарисање
fastcommentsRecentComments Недавни коментари широм сајта
fastcommentsRecentDiscussions Недавно активне дискусије
fastcommentsReviewsSummary Резиме рецензија са оцјенама у звездама
fastcommentsTopPages Највише дискутоване странице
fastcommentsUserActivityFeed Фид активности корисника

Примери

{# Број коментара у линији са текстом #}
This page has {% fastcommentsCommentCount { tenantId: "demo" } %} comments.

{# Чет уживо #}
{% fastcommentsLiveChat { tenantId: "demo" } %}

{# Колаб чет — циљајте елемент садржаја помоћу CSS селектора #}
<article id="post-body">
  <p>Highlight me to leave a comment.</p>
</article>
{% fastcommentsCollabChat { tenantId: "demo", target: "#post-body" } %}

{# Чет на слици — циљајте елемент слике помоћу CSS селектора #}
<img id="hero" src="/hero.jpg" alt="Hero image" />
{% fastcommentsImageChat { tenantId: "demo", target: "#hero" } %}

{# Резиме рецензија #}
{% fastcommentsReviewsSummary { tenantId: "demo" } %}

{# Фид активности корисника #}
{% fastcommentsUserActivityFeed { tenantId: "demo", userId: "demo:demo-user" } %}

Опције плагина Internal Link

eleventyConfig.addPlugin(fastcommentsPlugin, {
    // Региструјте само подскуп shortcode-ова:
    shortcodes: ['fastcomments', 'fastcommentsCommentCount'],
    // Додајте префикс сваком регистрованом имену shortcode-а (нпр. "fc" -> "fcFastcomments"):
    prefix: 'fc'
});

Ручна употреба (без плагина) Internal Link

Svaki shortcode je такође извезен као самостална функција која враћа HTML низ:

const { fastcomments, commentCount } = require('fastcomments-11ty');

eleventyConfig.addShortcode('comments', fastcomments);
eleventyConfig.addShortcode('commentCount', commentCount);

Пример пројекта Internal Link

Функционалан примјер је укључен у директоријум example/:

cd example && npm install && npm start

Статус одржавања Internal Link

Ове компоненте су омотачи око наших основних VanillaJS компоненти. Можемо аутоматски ажурирати ове компоненте (поправљати грешке, додавати функције) без објављивања ове библиотеке, па иако можда неће бити објављена неко вријеме, то не значи да FastComments није у активној развоју! Слободно погледајте наш блог за ажурирања. Промјене API-ја које крше компатибилност или нове функције никада неће бити испоручене у основну библиотеку без повећања верзије у овој библиотеци.

Потребна помоћ?

Ако наиђете на било какве проблеме или имате питања у вези Eleventy (11ty) библиотеке, молимо вас:

Допринеси

Допринеси су добродошли! Молимо посетите репозиторијум на GitHub-у за смернице о доприносу.