Phenquestions
Стандартна знижка
Markdown - це стандарт, розроблений Джоном Грубером. Головна мета Markdown - зробити файл можливим для читання навіть у чистому тексті. Якщо ви хочете заглянути в текстовий редактор, вам слід легко прочитати його. Це дуже корисно для користувачів vim та подібних. Зверніть увагу і пам’ятайте, що це стандарт для зміни текстових файлів. Він не замінює HTML. Натомість ви використовуєте його для створення HTML, де це корисно. У випадку з GitHub вони відформатують файл Readme на сайті. Поки ви дотримуєтеся стандарту, ви можете бути впевнені, що він буде виглядати добре.
Оскільки GitHub додав лише кілька розширень, вам слід почати з використання шпаргалки Markdown і перейти звідти. Ось список найпоширеніших.
| Націнка | Розширення | Результат |
| # (1 на рівень) | Заголовки | |
| * | Курсивом | |
| ** | Сміливий | |
| > | Блок-цитата | |
| 1. (і т.д.) | Впорядкований список | |
| - | Невпорядкований список | |
| 'код' | Ваш код | |
| "' | Md-доп | Початок і кінець блоку коду |
| - | Горизонтальне правило | |
| [Опис] (https: // www.приклад.com) | Ім'я в квадраті та URL-адреса у звичайних дужках | |
| ![альтернативний текст] (зображення.PNG) | Те саме, посилання на зображення | |
| [1] | Md-доп | Виноска |
Списки можна вкладати, відступаючи будь-які елементи, які ви хочете вкласти.
Інші розширення звичайного Markdown, у вас є код, який блокує розширення вище. Вони не завжди підтримуються службами.
| Націнка | Розширення | Результат |
| ### Заголовок # custom-id | Md-доп | Заголовок, до якого ви можете звернутися за його ідентифікатором |
| термін: визначення | Md-доп | Список термінів із визначеннями |
| ~ Помилковий текст ~ | Md-доп | Закреслений текст |
| - [x] Завдання, яке потрібно виконати | Md-доп | Список завдань, який ви можете позначити |
Таблиця дуже проста, але для її відображення потрібно кілька рядків: Таблиця:
| Назва | ЦІННІСТЬ || ----------- | ---------- |
| Килимки | 100 |
Розширення GitHub.
GitHub додав кілька розширень, щоб спростити обробку посилань на інших людей та проекти. Деякі з них є таблицями, згаданими раніше. Найбільше вам допоможе розширення з автоматичним посиланням. Він створює посилання самостійно, коли ви використовуєте його на GitHub.
Інші - таблиці та елементи списку завдань. Вони зручні для відстеження ваших завдань у проектах. Останнє, про яке слід згадати, - це розширення "Заборонено Raw HTML". За допомогою цього розширення деякі теги фільтруються під час відтворення для HTML. Ці теги можуть викликати дивні ефекти при отриманні на GitHub.
Шляхи вивчення GitHub Markdown
Якщо вас це бентежить, ви також можете перейти на сторінку GitHub і скористатися вбудованим редактором. Коли ви використовуєте його, він автоматично заповнює деякі функції. Це працює лише для проблем, але ви можете використовувати його, щоб зрозуміти деякі речі, смайли виходять у вигляді списку, коли ви вводите двокрапку (:).
Ви також можете знайти проект на GitHub, який має чудовий файл README і клонувати його на локальний диск. Звідти ви можете дослідити файл за допомогою будь-якого редактора, який забажаєте. Для великих редакторів, Emacs та Vim, існує підтримка націнки через розширення.
Якщо ви використовуєте vim, ви можете додати розширення для підсвічування синтаксису з GitHub, vim-markdown. Це розширення показує, що ви правильно ввели код. Щоб допомогти вам побачити, як це виглядає після завершення, ви також можете отримати розширення для прямої позначки. Завдяки цьому ви можете запустити веб-сервер, який відображатиме результати в режимі реального часу під час набору тексту.
Завдяки Emacs у вас є режим нетерплячого режиму, режим прямої зупинки та попередній перегляд у реальному часі. Усі вони відображають отриману сторінку в браузері, поки ви вводите текст. Перший вимагає менше бібліотек, ніж другий, але потребує додаткового фрагмента коду для запуску.
Висновок
Незважаючи на те, що націнка є невеликою і завідомо простою специфікацією, це може трохи заплутати початок роботи. Найкращий спосіб навчитися - це використовувати шпаргалку і писати документ Markdown. Ви можете оновити README.md на GitHub, і ви можете отримати велику підтримку від вбудованих функцій вашого редактора. Як додаткове зауваження, GitHub також підтримує смайли, які ви можете додати до свого документа. Ви можете використовувати шпаргалку, щоб знайти, якими вони є.
Завантажте Markdown-CheatSheetHere
