Dokumentacja

Wymagania

To są wymagania pierwszej wersji, czyli tej dla WordPressa. Każda kolejna platforma dostaje własną wersję z własnymi wymaganiami, a stan prac nad każdą z nich znajdziesz na stronie Działa z Twoim systemem CMS.

• WordPress 6.0 lub nowszy
• PHP 8.1 lub nowszy
• Klucz API od OpenAI, Anthropic, Google lub Mistral
• Bez zależności od crona, bez dostępu do powłoki, bez Node na serwerze

Instalacja

1. Wtyczki, Dodaj nową, Wyślij wtyczkę na serwer, wybierz plik zip, Zainstaluj teraz.
2. Włącz wtyczkę.
3. Ustawienia, DFYe. Wklej Twój klucz do modelu i zapisz.

Pierwsze indeksowanie rusza od razu. Na dużej stronie trwa dalej w tle, a widżet zaczyna działać, gdy tylko zakończy się pierwszy przebieg.

Wybór tego, co trafia do indeksu

Domyślnie DFYe indeksuje każdy opublikowany wpis, każdą stronę i każdy produkt. Nigdy nie indeksuje:

• Niczego, co Twoja wtyczka SEO oznaczyła jako noindex
• Niczego chronionego hasłem ani prywatnego
• Szkiców, wersji roboczych ani treści w koszu

Wszystko inne wyłączysz przełącznikiem przy pojedynczym wpisie, w panelu bocznym edytora.

Wygląd widżetu

Każda decyzja o wyglądzie to własna właściwość CSS na elemencie widżetu. Ustawisz je w panelu ustawień albo w Twoim motywie, jeśli wolisz trzymać to w kodzie:

dfye-chat {
  --dfye-action:    #6c4dff;   /* Twój kolor akcentu: dymek pytania, przycisk wysyłania, przycisk otwierający */
  --dfye-action-on: #ffffff;   /* tekst na kolorze akcentu */
  --dfye-bg:        #ffffff;   /* nagłówek i pole wiadomości */
  --dfye-surface:   #ffffff;   /* panel */
  --dfye-ink:       #0b0d12;   /* tekst */
  --dfye-radius:    18px;
  --dfye-font:      "Your Face", system-ui, sans-serif;
}

Widżet celowo używa domyślnie czcionki systemowej odwiedzającego, więc nigdy nie każe Twojej stronie pobierać kroju pisma. Własny podasz przez --dfye-font. Tryb ciemny włącza się sam; przypniesz go na stałe atrybutem data-theme="dark" na elemencie, jeśli Twoja strona zawsze jest ciemna.

Widżet renderuje się wewnątrz shadow root, więc nic z Twojego motywu nie przenika do środka i nic z widżetu nie wycieka na zewnątrz. Dlatego te właściwości to cała powierzchnia zmiany wyglądu: nie ma tu arkusza stylów, z którym trzeba walczyć.

Kod osadzenia, na dowolnej platformie

Widżet to zwykły skrypt i nie obchodzi go, co wygenerowało stronę dookoła niego, więc działa w systemie CMS, dla którego nie ma jeszcze wtyczki, i na stronie bez żadnego systemu CMS. Wtyczka dokłada do tego czytanie: przechodzi po Twoich opublikowanych stronach, utrzymuje indeks w zgodzie z nimi, gdy coś zmienisz, i prowadzi dziennik pytań. Jeden znacznik script dla widżetu pływającego:

<script src="https://dfye.com/w.js" data-dfye="demo" defer></script>

Albo kontener na panel osadzony w treści, czyli to, czego używa strona demo:

<div data-dfye-inline data-opening="Zapytaj mnie o cokolwiek."></div>
<script src="https://dfye.com/w.js" defer></script>

Limit rozmiaru

Budowanie kończy się błędem, jeśli widżet przekroczy 20 kB po gzipie. Obecna wersja to 9.7 kB po gzipie, 8.3 kB w brotli, 27.1 kB bez kompresji. Tę liczbę wpisuje na tę stronę samo budowanie, więc nie może rozminąć się z rzeczywistością.

Jeszcze nie gotowe

Uczciwa lista tego, co ta dokumentacja opisuje, a czego wtyczka dziś nie robi:

• Sama wersja dla WordPressa. Widżet i silnik wyszukiwania treści są gotowe; kolejna w kolejce jest nakładka w PHP, a wszystkie pozostałe platformy ze strony Działa z Twoim systemem CMS czekają za nią.
• Klucz licencyjny i endpoint aktualizacji.
• Dziennik pytań w panelu administratora.

Postępy śledzimy na stronie premiery, a aktualizujemy je wtedy, gdy coś faktycznie powstanie, a nie z góry.