Кодовый блок Markdown отлично подходит для написания фрагментов кода. Однако, когда вы пытаетесь опубликовать или поделиться им через платформу блога, есть некоторые недостатки. Гист может помочь преодолеть разрыв. GIST делает ваш блог лучше и легче поддерживать. В этом посте давайте посмотрим, как автоматизированное создание GIST может улучшить ваш технический опыт ведения блога.
GIST – это репозиторий GitHub, где вы можете хранить и обмениваться кодом/данных с другими. Одна суть может хранить несколько файлов. Синтаксическое выделение поддерживается на основе типа расширения файла, поэтому будьте осторожны, когда вы назовите файл. GIST могут быть публичными или секретными. Обратите внимание, что секретные GIST не являются частными, то есть любой, у кого есть URL -адрес, сможет просматривать код/данные.
Зачем использовать GIST?
Поддерживает функции репозитория GitHub, такие как контроль версий, Fork & Clone.
Способность подписаться, звезда и комментарии позволяют GIST легко сотрудничать с другими.
GIST может быть обмен несколькими способами без какой -либо зависимости или установки.
Мой текущий рабочий процесс для ведения блога заключается в следующем:
- Используйте Nopyter Notebook, чтобы написать блог.
- Загрузите ноутбук в качестве файла Markdown.
- Внесите изменения в файл Markdown, прежде чем публиковать на платформах, таких как Средний & Девто
В шаге 3 есть много ручных процессов, которые я планирую решить в ближайшие несколько недель. Сейчас моя самая большая проблема – то, как выглядит фрагмент кода на разных платформах. Быть более конкретным:
- Нет простого способа внести изменения в фрагменты кода после публикации
- Средний теряет синтаксис выделения
- Невозможно выделить конкретные строки в длинном фрагменте кода на обеих платформах
Гист помогает решить все эти проблемы. Также в качестве бонуса все фрагменты кода из одного и того же блога могут быть сгруппированы вместе через GIST. Это облегчает ссылку/доступ (при необходимости).
Цель состоит в том, чтобы создать GIST для файла Markdown, где каждый фрагмент кода будет отдельным файлом.
Сначала мы скачаем токен для создания сустава, как упомянуто в этот пост и хранить его в файле с именем – create_gist_token.txt
Мы можем прочитать файл разметки с помощью Python и использовать регулярное выражение, чтобы найти все блоки кода. Кодовый блок для Python создается путем завершения кода между “ в файле Markdown. Флаг репутация S Убедитесь, что совпадение также включает в себя и Newline
Как упоминалось ранее, каждый фрагмент кода будет отдельным файлом в GIST, поэтому нам нужно имя для каждого. Чтобы сделать это просто, мы возьмем первый комментарий в качестве имени файла.
Описание GIST будет первым заголовком файла Markdown. Как правило, это будет название блога, так что этого должно быть достаточно. Теперь мы можем собрать все данные и сделать вызов API.
В качестве DEV для поддержки жидкого текста нам нужно специальное форматирование для встраивания GIST по сравнению со средой. На обеих платформах нам нужно указать файл, чтобы вся GIST не отображалась.
Проверьте все загруженные файлы и замените их на соответствующие вставки GIST в файле Markdown. Я включил встраивание для обеих платформ, не стесняйтесь модифицировать их в соответствии с вашими потребностями.
Пересмотреть сценарий, чтобы облегчить запуск из командной строки.
Гист весьма полезен и обращается к многим любимым мозоли в блогах. Нам удалось собрать сценарий Python, который может уменьшить ручные усилия, необходимые для публикации блога. Не стесняйтесь обращаться ко мне через Twitter Или комментируют ваши мысли об этом посте.
Оригинал: “https://dev.to/6aravind/automate-gist-creation-from-markdown-file-using-python-2la5”