Який файл використовує розширення .md і як їх редагувати?


878

У GitHub декілька проектів мають README.mdфайли. Здається, простий форматний файл для вираження тексту та зображень.

Я думаю, десь є редактор чи синтаксичне пояснення.

Де я можу знайти вступ до .mdфайлів?


38
Я думаю, це свідчить на користь використання .markdownрозширення натомість, хоча це так жахливо довго ...
endolith

7
Ось посилання, яке може допомогти вам -> .MD Розширення файлу
Vipin Kr. Сінгх

1
MarkPad - це приємна програма для редагування MarkDown в Windows. У ньому подано попередній перегляд правок.
skjoshi

1
Користувач може спробувати MarkView , розширення Chrome для редагування та перегляду файлу розмітки всередині браузера.
swcool

1
Повне керівництво , щоб допомогти вам почати з markdown: blog.wax-o.com/2014/04 / ... . Вам слід спробувати написати відмітку способом живої візуалізації результату (із додатком, наприклад mouapp.com ). Чи знаєте ви, що синтаксис публікації та коментарів stackoverflow заснований на розмітці? :) stackoverflow.com/editing-help
Фаб'єн

Відповіді:


732

Відмітка - це формат простого тексту. Розширення .mdта .markdownпросто текстові файли, записані в синтаксисі Markdown . Якщо у вас є Readme.mdрепо, GitHub покаже вміст на домашній сторінці репо. Прочитайте документацію:

Ви можете редагувати Readme.mdфайл у самому GitHub. Натисніть на Readme.md, ви знайдете кнопку редагування. Ви можете попередньо переглянути свої зміни і навіть зробити їх звідти.

Оскільки це текстовий файл, для редагування та зміни його можна використовувати Блокнот або Блокнот ++ (Windows), TextEdit (Mac) або будь-який інший текстовий редактор. Існують спеціалізовані редактори, які автоматично аналізують розмітку під час її введення та генерують попередній перегляд, а інші застосовують різні кольори синтаксису та прикраси до відображуваного тексту. В обох випадках, проте, збережений файл все ще є читаним текстовим файлом.

Якщо ви хочете створити mdфайл з попереднім переглядом і якщо ви не хочете встановлювати жодних спеціальних редакторів, ви можете використовувати онлайн-редактори, такі як dillinger.io та stackedit.io . Вони забезпечують попередній попередній перегляд. Ви також можете експортувати свої файли на Google Диск або Dropbox .


27
Я вважав, що основне пояснення Github дуже корисне і як швидке введення.
Voo

2
У Windows, можливо, ви хочете використовувати WordPad, щоб скористатися форматуванням для легшого читання.
G O'Rilla

4
@ GO'Rilla, ІМХО уникайте WordPad, як чуми, якщо не писати собі невеликих записок, якими ви ніколи не поділитесь ні з ким. Те, що він додає до .txt-файлу, може спричинити хаос для інших редакторів (vim, Notepad ++ тощо). Набагато краще працювати в простому тексті при роботі з .txt і використовувати текстовий процесор або Acrobat для текстових файлів, що не містять .txt, таких як .doc та .pdf.
лабіринт

1
чи можемо ми додати зображення або через посилання у .md файл ... чи це можливо?
Рафаель

1
@ user1645290 Так, це можливо. дивіться
B-GangsteR

87

Якщо ви шукаєте редактора, пропоную скористатися http://dillinger.io/ . Це простий текстовий редактор на основі браузера, який може виводити Markdown на льоту.

Однак якщо ви віддаєте перевагу додатку та використовуєте OS X, ви можете спробувати Mou . Це досить непогано і насичено прикладами.


2
Здається, повертається до життя?
GuiSim

5
Я хотів би запропонувати http://dillinger.io/ , ще один дуже класний текстовий редактор на основі браузера. Це також дозволяє зв’язати Dropbox, Github та Google Drive.
серЛіско

Посилання «Блокнот» у цій відповіді викликає завантаження файлу RAR. Чому немає веб-сторінки, ви не сказали, що це редактор на базі браузера?
evanrmurphy

це посилання більше не діє
Карлос Плієго

Тільки зазначивши, що це не повна відповідь на питання. Ви не пояснюєте, що таке .md, лише як його можна редагувати
Зоя


33

Текстовий редактор Microsoft Visual Studio Code вбудований у підтримку файлів .md, записаних у синтаксисі розмітки.

Синтаксис автоматично кодується кольором всередині .md-файлу, і вікно попереднього попереднього перегляду розміченої розмітки можна переглянути, натиснувши Shift+Ctrl+V (Windows) або Shift+Cmd+V(Mac).

Щоб побачити їх поруч, перетягніть вкладку попереднього перегляду в праву частину редактора або використовуйте Ctrl+K V(Windows) або Cmd+K V(Mac).

введіть тут опис зображення

Код VS використовує позначену бібліотеку для розбору, і за умовчанням увімкнена підтримка Github Flavored Markdown , але він не відображатиме вбудований Github Emoji, як текстовий редактор Github Atom робить .

Крім того, підтримка VS Code має кілька плагінів для розмітки для розширеного функціоналу.


Якщо ви використовуєте Visual Studio 2015 замість цього, дивіться мою відповідь нижче.
bytedev

1
Примітка - ви можете натиснути правою кнопкою миші на файл readme> відкрити попередній перегляд
Chris Halcrow

15

Розширення ' .md ' відноситься до Markdown файлів .

Якщо ви не хочете встановлювати додаток, щоб прочитати їх у такому форматі, ви можете просто використовувати TextEdit або Xcode , щоб відкрити його на Mac.

У будь-якій іншій ОС ви маєте змогу відкрити його за допомогою будь-якого текстового редактора , хоча, як і очікувалося, його ви не побачите у форматі Markdown .


4
На насправді, ви будете бачити його в форматі Markdown. Ви не побачите це як жирний шрифт, курсив, відступи та блоки коду.
Гонки легкості на орбіті

14

Так, саме GitHub ароматизував Markdown . Включення файлу README у ваше сховище допоможе іншим швидко визначити, про що йдеться та як його встановити. Дуже корисно включити у свій репост.


5
Захищений. Під "одним" у "включенні одного у ваше сховище" ви повинні означати "файл README у будь-якому форматі", а не лише "файл README.md". Але питання задається взагалі про ".md" файли, а не про README взагалі. Тож ця відповідь не має значення для питання. Крім того, неоднозначність з "одним" може змусити читача думати, що Markdown README обов'язково кращі, ніж інші README, що неправильно.
Рорі О'Кайн

1
Я вніс зміни, зазначені в попередньому коментарі, оскільки це має сенс, і я думаю, що це може допомогти уникнути плутанини. Я не думаю, що це дуже гарна відповідь, оскільки це не додає нічого нового, що є актуальним. Це питання не стосується README, це розширення .md. Немає підстав додавати цю відповідь через шість тижнів після того, як прийнята відповідь надала ту саму інформацію.
Ерік Робертсон


5

Відмітка - це лише текстовий файл, який необов'язково має .mdабо .markdownрозширення. Його можна перетворити на HTML. Щоб знати синтаксис Markdown, ознайомтесь

GitHub Flavoured Markdown .

Ви можете використовувати будь-який текстовий редактор для розмітки. Якщо ви sublime textкористувач, ви можете перевірити Markdown Previewплагін, який відображатиме відображений вміст розмітки у веб-переглядачі та оновлюватиметься щоразу, коли ви зміните файл розмітки.

Деякі з онлайн-редакторів розмітки



3

Я пропоную StackEdit . Це простий редактор WISIWIG. Можна використовувати як редактор, так і синтаксис розмітки. Там є синтаксис довідки про швидку розмітку. Скасувати / повторити, коментарі, взаємозв’язок GoogleDrive, Dropbox.




2

Якщо ви створюєте .md файли для своїх .NET рішень, я рекомендую розширення Markdown Editor для Visual Studio 2015 оскільки на ньому є панель попереднього перегляду, щоб ви могли побачити зміни в режимі реального часу.

EDIT : Це також має працювати зараз із Visual Studio 2017.


0

Найпростіше, якщо у вас немає читача, - це відкрити файл MD за допомогою текстового редактора, а потім записати файл MD у вигляді HTML-файлу, а потім двічі клацнути, щоб переглянути його за допомогою браузера.


Це буде працювати лише в тому випадку, якщо у вас є плагін, який читає .md файли.
Бред Брюс

0

.Md означає Markdown Text. В основному, це просто інший тип текстового файлу, наприклад .txt

Я використовую Notepad ++ для їх читання та редагування

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.