Документация / Каналы

Dev.to

Подключите аккаунт Dev.to по ключу API и публикуйте посты как статьи в Markdown с обложкой, тегами и каноническим адресом.

English version · API для разработчиков

Содержание

Dev.to — блоговая платформа. Здесь пост превращается в статью: первая строка текста — заголовок, остальное — тело статьи в Markdown. Общие вещи о каналах описаны в разделе Каналы: обзор.

Что можно публиковать

  • Текст и ссылка — статья из подписи. Для ссылки адрес добавляется в конец статьи после пустой строки.
  • Изображение — одно, оно становится обложкой статьи. Берётся первое изображение поста.

Видео не поддерживается. Лимит длины текста сервис не задаёт.

Как подпись превращается в статью:

  1. Первая непустая строка — заголовок статьи. Если она начинается с # и пробела, эти знаки отбрасываются.
  2. Всё, что ниже, — тело статьи в Markdown.
  3. Если в подписи одна строка, она же становится и телом статьи.

Заголовок не может быть пустым. Статья публикуется сразу, если не включено сохранение черновика.

Перед началом

Вам нужен аккаунт Dev.to и ключ API. Создайте его в Dev.to: откройте Settings, затем Extensions, раздел DEV Community API Keys, и сгенерируйте ключ.

Ключ хранится вместе с каналом и отправляется только в Dev.to.

Подключение

  1. Откройте Каналы и нажмите Добавить каналы.
  2. В карточке Dev.to нажмите Dev.to.
  3. На странице Подключить аккаунт Dev.to вставьте ключ в поле Ключ API и нажмите Подключить. Сервис проверяет ключ, спрашивая у Dev.to, кому он принадлежит.
  4. На странице Добавьте новые каналы отметьте аккаунт и нажмите Добавить новый.

Канал появится в списке с именем и логином вида @username; картинка и имя ведут на ваш профиль Dev.to.

Настройки в редакторе поста

Когда в редакторе выбран канал Dev.to, под полем текста появляется блок Dev.to с подсказкой о заголовке и обложке и тремя настройками:

  • Теги (до 4, через запятую) — теги статьи через запятую, не больше четырёх. Знак # в начале тега и повторы убираются; из тегов удаляются все символы, кроме букв и цифр. Если тегов больше четырёх, редактор сообщит об ошибке.
  • Канонический URL — адрес оригинала, если статья уже опубликована в другом месте. Принимается только корректный адрес; иначе поле игнорируется.
  • Сохранить как черновик — отметьте, чтобы сохранить статью в черновиках Dev.to вместо публикации.

Если что-то не работает

  • Введите ваш ключ API. — поле ключа пустое.
  • Если ключ не подошёл, сервис показывает ответ Dev.to. Создайте новый ключ и повторите.
  • Dev.to: первая строка текста — заголовок статьи, а она пуста. — подпись пуста или начинается с пустого заголовка. Напишите заголовок первой строкой.
  • Dev.to: an article takes at most 4 tags. — оставьте не больше четырёх тегов.
  • У аккаунта Dev.to нет ключа API. Переподключите его. — доступ потерян, например ключ отозван. Нажмите Переподключить на карточке канала и введите новый ключ.
  • Dev.to вернул ответ, который не удалось прочитать. — ответ не удалось разобрать; проверьте профиль Dev.to, прежде чем публиковать повторно.

Подробнее о переподключении и статусах каналов — в разделе Каналы: обзор.