Що таке "README-файл" у форматі "розмітка" на Github?

27

Мені незрозуміло, що таке формат, якщо є систематичні / командні рядкові вимоги для його створення тощо.

В основному, просто потрібно знати характеристики, і якщо є технічні кроки для створення файлу README.

github

— промахи
джерело

4

Ні, просто текстовий файл, який ви редагуєте вручну. Щодо синтаксису, en.wikipedia.org/wiki/Markdown

— Андреа

3

це той самий формат wiki-edit, який використовує ця сторона.

— k3b

+1 @Andrea: Дякую, хоча я можу придумати більше кількох форматів розмітки, який формат та версію очікують у Github? Крім того, ви коментуєте як більшу відповідь, будь ласка, опублікуйте це як повну відповідь. Ще раз дякую!

— помилки

+1 @ K3b: Повірте, ви щось на те, чи говорите ви про використання Github Gollum , що, наприклад, дозволяє відносно зв’язувати? Якщо так, будь ласка, опублікуйте це як відповідь, оскільки я вважаю, що це правильна відповідь. Спасибі!

— промахи

37

Розмітка - це простий синтаксис для надання семантичної інформації та представлення загального форматування у простому тексті. Смілива Fireball має приголомшливий синтаксичний посібник для стандартного розмітки . Потім GitHub використовує варіант цього, який вони називають GitHub Flavored Markdown .

Щоб налаштувати ваш readme, просто створіть звичайний текстовий файл та назви його README (або README.md / README.markdown) та закріпіть його на корені репо-репортажу. Потім GitHub підбере це під час проекту.

— Кім Берджесс
джерело

2

Я також створив відео, де пояснюється, як використовувати Markdown. Ви можете знайти його тут: mikemclin.net/markdown-syntax-language

— Майк Маклін

9

Вікіпедія - Markdown посилається на сторінку "GitHub Flavored Markdown - Вступ" ( арк. )

Цитата зі сторінки:

GitHub використовує те, що ми називаємо "GitHub Flavored Markdown" (GFM) для повідомлень, проблем та коментарів. Він відрізняється від стандартного Markdown (SM) кількома значущими способами та додає деяку додаткову функціональність.

На сторінці також описано відмінності від стандартного Markdown.

Також є додаткова інформація про те, як насправді рендеринг GitHub видає Markdown:

Якщо вас цікавить, як ми надаємо файли Markdown, ви можете перевірити Redcarpet , наш інтерфейс Ruby до бібліотеки Sundown .

(Мабуть, Sundown - це фактичний аналізатор Markdown, який використовується за шторами.)

Щоб додати ще один шар абстракції, Sundown - це вилка ще одного аналізатора Markdown :-)
Цитата зі сторінки GitHub Sundown :

Sundown - це розбір Markdown, заснований на оригінальному коді бібліотеки Upskirt від Natacha Porté.

— Крістіан Шпехт
джерело

1

Це дуже дивно, але виглядає так, ніби GitHub не використовує GitHub-ароматизований Markdown (GFM) під час надання файлу README.

GitHub використовує "GitHub Flavored Markdown" або GFM по всьому сайту - у питаннях, коментарях та запитах на потяг.

Замість цього, здається, використовується версія, яка називається redcarpet, як частина проекту розмітки GitHub . Вони також підтримують декілька інших форматів розмітки, включаючи MediaWiki. Просто скористайтеся правильним розширенням файлу, і GitHub візуалізує розмітку.

Якщо ви хочете побачити відмінності між двома різними смаками Markdown, прочитайте опис GFM та його додаткові особливості .

— Дон Кіркбі
джерело

1

redcarpet та Github Flavored Markdown - це дві окремі, але взаємодоповнюючі концепції, що не є конкуруючими реалізаціями одного і того ж. redcarpet в основному компілятор , який приймає речі , написані в Github ароматизованого Markdown мови і виводить HTML або XHTML.

— 8bittree