Початок роботи з Markdown
Авторка: Сара Сімпкін Переклала на українську: Орися Віра Оригінал уроку: https://programminghistorian.org/en/lessons/getting-started-with-markdown
У цьому уроці ви ознайомитеся з Markdown — синтаксисом звичайного тексту для форматування документів. Ви дізнаєтеся, чому його використовують, як форматувати файли Markdown, та як переглядати документи у форматі Markdown в Інтернеті.
Цілі уроку
У цьому уроці ви ознайомитеся з Markdown — синтаксисом звичайного тексту для форматування документів. Ви дізнаєтеся, чому його використовують, як форматувати файли Markdown, та як переглядати документи у форматі Markdown в Інтернеті.
[Примітка від перекладача: У проєкті Programming Historian уроки подаються як файли Markdown, тож авторка уроку включила приклади, які охоплюють тематику РН. При перекладі їх було залишено, щоб читачі могли також орієнтуватися в оригіналі тексту.]
Що таке Markdown?
Розроблений у 2004 році Джоном Грубером, Markdown має відношення як і до (1) способу форматування текстових файлів, так і до (2) утиліти Perl для перетворення файлів Markdown у HTML. У цьому уроці ми зосередимося на першій частині та навчимося писати файли за допомогою синтаксису Markdown.
Звичайні текстові файли мають багато переваг перед іншими форматами. По-перше, вони читаються практично на всіх пристроях. Також вони краще витримали випробування часом, ніж інші типи файлів (якщо ви коли-небудь намагалися відкрити документ, збережений у форматі застарілого текстового процесора, то вам відомі такі проблеми сумісності).
Використовуючи синтаксис Markdown, ви зможете створювати файли, які можна читати як звичайний текст і які будуть готові до стилізації на інших платформах. Багато систем ведення блогів, генераторів статичних сайтів і таких сайтів, як GitHub, також підтримують Markdown і перетворюють ці файли в HTML для відображення в Інтернеті. Крім того, такі інструменти, як Pandoc, можуть конвертувати файли в Markdown і з нього. Для отримання додаткової інформації про Pandoc, відвідайте урок Денніса Тенена та Ґранта Вітоффа про стійке авторство у звичайному тексті за допомогою Pandoc і Markdown.
Синтаксис Markdown
Файли Markdown зберігаються з розширенням .md і можуть бути відкриті в текстовому редакторі, наприклад TextEdit, Notepad, Sublime Text або Vim. Багато вебсайтів і видавничих платформ також пропонують вебредактори та/або розширення для введення тексту за допомогою синтаксису Markdown.
У цьому уроці ми попрактикуємося з синтаксисом Markdown у браузері за допомогою StackEdit. Ви зможете ввести текст у форматі Markdown ліворуч і одразу побачити відтворену версію поруч із ним, праворуч.
Оскільки всі уроки з історії програмування в проєкті Programming Historian написані в Markdown, ви також можете перевірити ці файли в StackEdit. У StackEdit натисніть "Start Writing" (Почати писати) у верхній панелі. Потім скопіюйте та вставте необроблений текст з уроку "Знайомство з командним рядком Bash" у редакторі:
https://raw.githubusercontent.com/programminghistorian/jekyll/gh-pages/en/lessons/intro-to-bash.md
Ви помітите, що хоча права панель має більш елегантне відображення тексту, оригінальний файл Markdown зліва все ще досить читабельний.
Тепер давайте зануримося в урок, написавши власний синтаксис Markdown. Створіть новий документ у StackEdit, натиснувши на піктограму папки у верхньому лівому куті та вибравши "New file" (Новий документ). Ви можете ввести назву документа в текстове поле зліва у верхній частині сторінки.
Заголовки
У Markdown доступні чотири рівні заголовків, які позначаються кількістю " # " перед текстом заголовка. Вставте наведені нижче приклади в текстове поле зліва:
# Заголовок першого рівня
## Заголовок другого рівня
### Заголовок третього рівня
#### Заголовок четвертого рівня
Заголовки першого та другого рівнів також можна ввести таким чином:
First level heading
=======
Second level heading
----------
Вони відображатимуться як:
Зверніть увагу, що синтаксис Markdown залишається зрозумілим навіть у версії звичайного тексту.
Абзаци та розриви рядків
Спробуйте ввести таке речення в текстове поле:
Ласкаво просимо до програми Programming Historian.
Сьогодні ми будемо вивчати синтаксис Markdown.
Це речення відокремлюється від попереднього одним рядком.
Це відображається як:
Абзаци повинні бути розділені порожнім рядком. Залиште порожній рядок між словом "Markdown" та словом "Це", щоб побачити, як це працює. У деяких варіантах Markdown потрібно також вказувати однорядкові переноси за допомогою двох порожніх пробілів в кінці кожного рядка. Це непотрібно у варіанті GitHub Flavored Markdown, який StackEdit використовує за замовчуванням.
Додавання виділеного тексту
Текст можна виділити курсивом, обгорнувши слово у символи * або _ . Подібним чином жирний текст, пишеться, обгортаючи слово у символи ** або _ _.
Спробуйте додати виділення у речення, використовуючи ці методи:
Я **в захваті** від уроків _Programming Historian_.
Складання списків
Markdown включає підтримку впорядкованих і невпорядкованих списків. Спробуйте ввести такий список у текстове поле:
Відступ * дозволить створити вкладені елементи.
Це відображається як:
Упорядковані списки записуються нумерацією кожного рядка. Знову ж таки, метою Markdown є створення документів, які можна читати як звичайний текст і які можна трансформувати в інші формати.
Це відображається як:
Фрагменти коду
Відображення фрагментів коду, що відрізняються від решти документа, є гарною практикою, яка покращує зручність читання. Зазвичай, код представлений у вигляді моноширинного формату. Оскільки Markdown не розрізняє шрифти, ми представляємо код, загортаючи фрагменти в символи зворотньої галочки, такі як `. Наприклад, `<br />`. Цілі блоки коду пишуться шляхом введення трьох символів зворотної галочки перед і після кожного блоку. У вікні попереднього перегляду StackEdit буде відображено затінене поле з текстом моноширинним шрифтом.
Спробуйте ввести такий текст у текстове поле:
Це відображається як:
Зверніть увагу, як блок коду відображається моноширинним шрифтом.
Блок цитат
Додавання " > " перед будь-яким абзацом відтворить його як елемент цитати.
Спробуйте ввести такий текст у текстове поле:
> Привіт, я абзац тексту, укладений у цитату. Зверніть увагу, як я зміщений від лівого поля.
Це відображається як:
Посилання можна писати двома стилями.
Вбудовані посилання створюються шляхом взяття тексту посилання спочатку в квадратні дужки, а потім потрібно взяти URL-адресу та опціональний альтернативний текст у круглі дужки.
Це відображається як:
Посилання у стилі виносок може бути зручним для приміток і може надати вашому звичайному текстовому документу більш акуратного вигляду. Ці посилання пишуться з додатковим набором квадратних дужок для встановлення мітки ідентифікатора посилання.
Потім ви можете додати URL-адресу до іншої частини документа:
Це відображається як:
Зображення
На зображення можна посилатися за допомогою " ! ", після якого в квадратних дужках варто розмістити деякий альтернативний текст, а потім URL-адресу зображення та необов’язковий заголовок. Вони не відображатимуться у вашому звичайному текстовому документі, але будуть вбудовані у відтворену HTML-сторінку.
Це відображається як:
Горизонтальні лінії
Горизонтальні лінії створюються, коли три чи більше " - ", " * " або " _ " включені в рядок окремо, незалежно від кількості пробілів між ними. Усі наведені нижче комбінації відображатимуть горизонтальні лінії:
Це відображається як:
Таблиці
Основна специфікація Markdown не містить таблиць, однак деякі сайти та програми використовують варіанти Markdown, які можуть містити таблиці та інші спеціальні функції. GitHub Flavored Markdown є одним із цих варіантів і використовується для відтворення файлів .md у браузері на сайті GitHub.
Щоб створити таблицю в GitHub, використовуйте вертикальну риску " | " для розділення стовпців і дефісів " - " між заголовками та іншим вмістом таблиці. Хоча вертикальні риски вкрай необхідні лише між стовпцями, ви можете використовувати їх зовні, по обидва боки таблиці, щоб виглядало більш естетично. Комірки можуть вміщати будь-яку кількість символів, і зовсім не обов’язково, щоб вертикальні риски були симетрично вирівняні одна з одною.
Це відображається як:
Щоб визначити вирівнювання кожного стовпця, двокрапки " : " можна додати до рядка заголовка таке:
Це відображається як:
Обмеження Markdown
Незважаючи на те, що Markdown стає дедалі популярнішим, особливо для оформлення документів, які можна переглядати в Інтернеті, багато людей і видавців все ще покладаються на традиційні документи Word, PDF-файли та інші формати файлів. Це можна частково вирішити за допомогою інструментів перетворення командного рядка, таких як Pandoc; однак певні функції текстового процесора, як-от відстеження змін, все ще мають певні обмеження. Щоб отримати додаткові відомості про Pandoc, відвідайте урок проєкту Programming Historian про стійке авторство у звичайному тексті з використанням Pandoc і Markdown.
Висновок
Markdown — це корисна "золота середина" між нестилізованими простими текстовими файлами та застарілими документами текстового процесора. Його простий синтаксис можливо швидко опанувати та він є досить зрозумілий як сам по собі, так і під час відтворення в HTML та інших типах документів. Врешті-решт, ваш вибір написання власних документів у Markdown означає, що вони будуть придатними для використання та читання в довгостроковій перспективі.
Про авторку
Сара Сімпкін є бібліотекарем з геоінформаційних систем, географії та комп’ютерних наук в Університеті Оттави.
Переклад українською: Орися Віра, PhD, викладач кафедри історії в Українському Католицькому Університеті
Переклад рецензували: Тарас Назарук, керівник напряму цифрової історії Центру міської історії; Кирило Осінський, Senior Software Engineer, Cheil Germany GmbH.
Рекомендоване цитування: Сімпкін, Сара. "Початок роботи з Markdown." Programming Historian, переклала Орися Віра, Посібник з цифрової історії, 2024. DOI: https://doi.org/10.69915/dh0012
Last updated
