Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 6.69 KB

README_pl_PL.md

File metadata and controls

93 lines (67 loc) · 6.69 KB

SiYuan
SiYuan Oembed and Ghost-style bookmark cards




Buy Me Coffee

English | Polish | 简体中文

✨ Opis wtyczki

Wtyczka ma dwie główne funkcjonalności:

  1. Pozwala na konwersję linków (URL) do ich osadzonej reprezentacji zgodnie z formatem Oembed. Gdy dana strona to obsługuje, link może zostać przekonwertowany bezpośrednio na zdjęcie, wideo lub inny format udostępniany przez stronę.

  2. Pozwala na konwersję linków (URL) do eleganckiej karty zakładki bazującej na kartach zakładek z Ghost CMS. Wykorzystałem implementację z mojego motywu Astro Simply.

Obie funkcjonalności są od siebie niezależne, więc możesz konwertować albo do oembed, albo do karty zakładki.

Działa to tak:

preview.png

przykład użycia

❗ Niestety, osadzenia z X.com (dawniej Twitter) są oparte na skryptach i nie udało mi się jeszcze ustalić, dlaczego skrypt nie jest wykonywany pomimo włączonego wykonywania skryptów w ustawieniach (zobacz: mój post na Liuyun.io) ❗

Facebook/Instagram wymaga klucza API (API_KEY) do osadzania ich treści, więc też raczej nie działa.

Z powyższych powodów oembed ma trochę ograniczoną użyteczność i być może będę musiał dodać osobną konwersję dla tweetów.

🖱 Użytkowanie

Wtyczka oferuje trzy sposoby konwersji linków:

  1. Komendy ukośnika (slash) z przypisanymi skrótami klawiszowymi:

    • /oembed, /Oembed, /oe, Ctrl+Shift+O dla konwersji Oembed
    • /card, /bookmark, /bk, Ctrl+Shift+C dla konwersji do karty zakładki Komendy ukośnika
  2. Menu ikony bloku po zaznaczeniu jednego lub więcej bloków: Menu ikony bloku

  3. Osobne ikony na pasku narzędzi: Ikony paska narzędzi

❗ Obie konwersje działają jako przełącznik. Uruchomienie akcji raz konwertuje link do oembed lub karty zakładki. Uruchomienie jej drugi raz przywraca zwykły link.

⚙ Ustawienia

Wtyczka posiada kilka ustawień konfiguracyjnych:

Ustawienie Wyjaśnienie
Przechwytuj linki ze schowka Automatycznie przekształcaj linki wklejane ze schowka na oembed lub kartę zakładki (:exclamation: Jeszcze nie zaimplementowane!)
Wybierz typ konwersji przy wklejaniu Jaki typ konwersji zastosować automatycznie podczas wklejania linku ze schowka (:exclamation: Jeszcze nie zaimplementowane!)
Włącz debugowanie Włącz szczegółowe debugowanie, aby pomóc w rozwiązywaniu problemów
Lista blokowanych domen dla oembed Lista domen do pominięcia przy konwersji (jedna na linię) ( Jeszcze nie zaimplementowane!)
Lista blokowanych domen dla kart zakładek Lista domen do pominięcia przy konwersji (jedna na linię) (Jeszcze nie zaimplementowane!)
Własny CSS dla kart zakładek Możliwość wprowadzenia własnego CSS do stylizacji kart zakładek. Można stylizować wszystkie klasy kg-card-* i kg-bookmark-*.

⌛ Problemy i ograniczenia

Obecnie wtyczka używa openGraphScraperLite do pobierania metadanych Open Graph i Twitter. Jest to jedyne narzędzie, które znalazłem, które daje się zbundlować z wtyczką bez problemów. Powoduje to również duży rozmiar wtyczki (ponad 3MB bez kompresji). Metascraper jest znacznie lepszy, ale niestety nie działa w środowisku klienckim wtyczki.

Inną opcją byłoby użycie API Microlink do pobierania metadanych linków, ale jest to ograniczone do 50 zapytań/dzień w darmowym planie.

Kolejnym ograniczeniem jest już wspomniany brak osadzeń Facebook/Instagram przez oembed oraz brak wykonywania skryptów do zapewnienia właściwego CSS dla X.com (Twitter).

🙏 Podziękowania