Добавьте легко читаемый код в свои истории

Medium является домом для одних из лучших руководств и ресурсов по программированию в Интернете. Многие из нас в Medium — разработчики, поэтому мы знаем, насколько они могут быть полезны при изучении новых навыков или решении сложной инженерной задачи.

Наша работа заключается в том, чтобы помочь писателям наилучшим образом поделиться своим опытом. Для технических писателей это частично связано с тем, чтобы упростить встраивание красивых блоков кода в истории. Medium некоторое время поддерживал блоки кода, но они отображались в виде обычного текста, что не идеально для удобочитаемости.

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

Блоки кода раньше выглядели так:

// my code feels hard to read
function oldCodeBlock() {
  return "thank u, next";
}

Теперь вы можете создавать новые блоки кода, которые выглядят следующим образом:

// highlighted code is easier to read
function newCodeBlock() {
  return “jazzy!”;
}

Они имеют лучшую читабельность, что облегчает вашим читателям понимание и изучение вашего кода.

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

Как создать новый блок кода?

В веб-редакторе историй, когда вы нажимаете кнопку +, вы увидите обновленную панель инструментов. Вы можете нажать кнопку «{ }», чтобы вставить новый блок кода.

Или вы можете ввести ``` прямо в редакторе:

В приложениях Medium для iOS и Android вы можете нажать кнопку «{ }», чтобы вставить новый блок кода.

После того, как вы создали блок кода, вы можете ввести свой код напрямую или вставить его из другого места.

А как насчет старых историй с кодовыми блоками? Как их обновить?

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

Если вы хотите обновить старый блок кода в опубликованной истории, вы можете отредактировать историю, создать новый блок кода и вставить в него содержимое старого блока.

Расскажите, что вы думаете

Мы рады представить вам новые инструменты для письма и хотели бы услышать ваши отзывы. Как мы могли бы продолжать улучшать блоки кода? Какие еще блоки контента или инструменты были бы вам полезны? Дайте нам знать в ответах.