- Що він робить
- Що він не робить
- Установка
- Використання
- Розширене використання
- Вимкнення виводу <title>
- Інформація про автора
- Налаштування виводу JSON-LD
- Налаштування виводу зображення
- Встановлення зображення за замовчуванням
- Заголовки SmartyPants
Додаток Jekyll для додавання тегів метаданих для пошукових систем і соціальних мереж для кращого індексування та відображення вмісту вашого сайту.
Що він робить
Jekyll SEO Tag додає до вашого сайту такі мета-теги:
Хоча ви можете теоретично додати необхідні теги метаданих себе, Jekyll SEO Tag надає тестовий шаблон для кращого досвіду.
Що він не робить
Тег Jekyll SEO призначений для отримання машиночитаних метаданих для пошукових систем і соціальних мереж для індексування та відображення. Якщо ви шукаєте щось, щоб проаналізувати структуру та зміст свого сайту Jekyll (наприклад, більш традиційну оптимізацію SEO), погляньте на Jekyll SEO Gem .
Тег Jekyll SEO не призначений для розміщення всіх можливих випадків використання. Він повинен працювати на більшості сайтів з коробки і без переліку варіантів конфігурації, які служать лише для того, щоб заплутати більшість користувачів.
Установка
- Додайте до файлу Gemfile наступного:
gem "jekyll-seo-tag"
- Додайте до _config.yml вашого сайту:
Дорогоцінні камені: - jekyll-seo-tag
- Додайте наступне право перед </head> у шаблон (и) вашого сайту:
{% seo%}
Використання
Тег SEO буде поважати будь-який з наступних, якщо він включений до _config.yml вашого сайту (і просто не включати їх, якщо вони не визначені):
- title - назва сайту (наприклад, чудовий сайт Ben, блог GitHub тощо)
- description - короткий опис (наприклад, блог, присвячений перегляду кінофайлів cat)
- url - повна URL-адреса вашого сайту. Примітка: site.github.url буде використовуватися за замовчуванням.
- автор - глобальна інформація про автора (див. нижче)
- twitter: username - ручка сайту Twitter. Ви хочете описати це так:
twitter: ім'я користувача: benbalter
- facebook - доступні такі властивості:
- facebook: app_id - ідентифікатор програми для Facebook
- facebook: видавець - URL-адреса сторінки Facebook або ідентифікатор видання
- facebook: admins - ідентифікатор користувача Facebook для довідки про домен, пов'язаний з особистим обліковим записом
Ви хочете описати одне або більше подібне:
facebook: app_id: 1234 видавець: 1234 адміністраторів: 1234
- логотип - URL-адреса логотипу на всьому сайті (наприклад, /assets/your-company-logo.png)
- соціальний - для визначення соціальних профілів . Доступні такі властивості:
- name - якщо ім'я користувача або організація відрізняється від імені сайту
- посилання - масив посилань на профілі соціальних медіа.
- date_modified - Вручну вказати поле dateModified у виводі JSON-LD для перевизначення власного dateModified Jekyll. Це поле займе перший пріоритет для виводу даних JSON-LD. Це корисно, коли тимчасова мітка файлу не відповідає справжньому часу, коли зміст змінювався. Користувач може також встановити Останнє змінення в який запропонує альтернативний спосіб забезпечення поля dateModified.
соціальні: ім'я: посилання Бен-Балтер: - https://twitter.com/BenBalter - https://www.facebook.com/ben.balter - https://www.linkedin.com/in/BenBalter - https: / /plus.google.com/+BenBalter - https://github.com/benbalter - https://keybase.io/benbalter `` `*` google_site_verification 'для перевірки права власності через інструменти для веб-майстрів Google * Крім того, перевірте право власності на кілька послуги відразу за допомогою наступного формату: `` yml webmaster_verifications: google: 1234 bing: 1234 alexa: 1234 yandex: 1234
- lang - мова, яку ці мітки позначені. Формат language_TERRITORY. За замовчуванням - en_US.
Мітка SEO повинна відповідати наступним вимогам YAML, якщо вона включена до публікації, сторінки чи документа:
- title - назва посади, сторінки або документа
- description - короткий опис вмісту сторінки
- image - URL-адреса зображення, пов'язаного з публікацією, сторінкою або документом (наприклад, /assets/page-pic.jpg)
- автор - інформація про автора сторінки, сторінки чи документа (див. нижче)
- lang - інформація щодо мови на сторінці, пост або документ
Розширене використання
Jekyll SEO Tag призначений для реалізації SEO кращих практик за замовчуванням і бути правильним для більшості сайтів прямо з коробки. Якщо з якихось причин потрібно більше контролювати висновок, читайте далі:
Вимкнення виводу <title>
Якщо з якоїсь причини ви не хочете, щоб плагін виводив <title> теги на кожній сторінці, просто викликайте плагін у вашому шаблоні так:
{% seo title = помилковий%}
Інформація про автора
Інформація про автора використовується для розповсюдження поля творця зведених карт Twitter. Це повинна бути авторська, а не загальна для сайту ручка Twitter (ім'я користувача для сайту буде збережено як site.twitter.username).
TL; DR: У більшості випадків, автор: [ваша ручка Twitter] знаходиться у передній частині документа, для сайтів з декількома авторами. Якщо вам потрібно щось більш складне, читайте далі.
Існує декілька способів передати цю специфічну для автора інформацію. Інформацію про автора можна знайти в наступному порядку:
- Об'єкт автора, який знаходиться в передній частині документів, наприклад:
автор: twitter: benbalter
- Об'єкт автора, в _config.yml сайту, наприклад:
автор: twitter: benbalter
- site.data.authors [author], якщо автор вказаний у передній частині документа, а відповідний ключ існує у site.data.authors. Наприклад, у передній частині документа є наступне:
автор: бенбалтер
У _data / authors.yml у вас є:
бенбалтер: фото: /img/benbalter.png twitter: jekyllrb potus: малюнок: /img/potus.png twitter: whitehouse
У наведеному вище прикладі ручка щебета автора benbalter буде вирішена до @jekyllrb. Це дозволяє централізувати інформацію про автора в одному файлі_даних / авторів для сайту з багатьма авторами, які вимагають більше, ніж просто ім'я автора.
Pro-tip: Якщо автори знаходяться у передній частині документа як масив (а автор - не), плагін використовуватиме першого переліченого автора, оскільки Twitter підтримує лише одного автора.
- Автор у передній частині документа (найпростіший спосіб), наприклад:
автор: бенбалтер
- Автор у _config.yml сайту, наприклад:
автор: бенбалтер
Налаштування виводу JSON-LD
Для будь-якої сторінки можна встановити наступні параметри. Хоча параметри за замовчуванням призначені для обслуговування більшості користувачів у найпоширеніших обставинах, можуть виникнути ситуації, коли необхідний більш точний контроль.
- seo
- name - Якщо назва речі, що представляє сторінка, відрізняється від назви сторінки. (тобто: "Кафе Франка" та "Ласкаво просимо до кафе Франка")
- type - тип речей, які відображає сторінка. Це має бути a Тип Schema.org і, ймовірно, зазвичай буде щось подібне BlogPosting , Стаття , Людина , Організація і т.д.
- links - масив інших URL-адрес, які представляють те ж саме, що і ця сторінка. Наприклад, біо-сторінка Джейн може містити посилання на профілі Джейн GitHub і Twitter.
Налаштування виводу зображення
Для більшості користувачів встановлення зображення: [path-to-image] на основі сторінки повинно бути достатньо. Якщо вам потрібний більший контроль над тим, як зображення представлені, властивість зображення також може бути об'єктом, з такими параметрами:
- path - Відносний шлях до зображення. Те ж, що і зображення: [шлях до зображення]
- height - Висота зображення Open Graph (og: image)
- width - Ширина зображення Open Graph (og: image)
Можна скористатися будь-яким із наведених вище додаткових властивостей, наприклад:
зображення: шлях: /img/twitter.png висота: 100 ширина: 100
Встановлення зображення за замовчуванням
Ви можете визначити зображення за умовчанням за допомогою Front Matter за замовчуванням , щоб надати всім вашим повідомленням і сторінкам зображення за умовчанням або карткою Twitter.
Ось один з основних прикладів: вам пропонується адаптуватися до своїх потреб:
defaults: - scope: path: "" значення: image: /assets/images/default-card.png
Заголовки SmartyPants
Заголовки оброблятимуться за допомогою Захисний фільтр Jekyll . Це допоможе SmartyPants перевести звичайну пунктуацію ASCII у "розумну" друкарську пунктуацію. Це не відображатиме та не видалятиме будь-яку відмітку, яку ви можете використовувати у заголовку сторінки.