Какой файл использует расширение .md и как мне их редактировать?

879

На GitHub несколько проектов имеют README.mdфайлы. Это похоже на простой формат файла для выражения текста и картинок.

Я предполагаю, что где-то есть редактор или объяснение синтаксиса.

Где я могу найти введение в .mdфайлы?

Лай Юй-Сюань
источник
38
Я предполагаю, что это свидетельствует в пользу использования .markdownрасширения вместо этого, хотя это так ужасно долго ...
эндолит
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
fabien

Ответы:

733

Markdown - это текстовый формат файла. Расширения .mdи .markdownявляются просто текстовыми файлами, написанными в синтаксисе Markdown . Если у вас есть Readme.mdрепо, GitHub покажет содержимое на домашней странице вашего репо. Прочитайте документацию:

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

Поскольку это текстовый файл, для его редактирования и изменения можно использовать Notepad или Notepad ++ (Windows), TextEdit (Mac) или любой другой текстовый редактор. Существуют специализированные редакторы, которые автоматически анализируют уценку по мере ее ввода и генерируют предварительный просмотр, в то время как другие применяют различные цвета синтаксиса и декорации к отображаемому тексту. Однако в обоих случаях сохраненный файл остается читаемым текстовым файлом.

Если вы хотите создать mdфайл с предварительным просмотром и не хотите устанавливать какие-либо специальные редакторы, вы можете использовать онлайн-редакторы, такие как dillinger.io и stackedit.io . Они обеспечивают предварительный просмотр в реальном времени. Вы также можете экспортировать свои файлы в Google Drive или Dropbox .

Dikei
источник
27
Базовое объяснение Гитхаба мне показалось очень полезным в качестве краткого введения.
Во
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 . Это довольно хорошо и полно примеров.

sirLisko
источник
2
Кажется, вернулся к жизни?
GuiSim
5
Я хотел бы предложить http://dillinger.io/ , еще один действительно крутой браузерный текстовый редактор. Он также позволяет связывать Dropbox, Github и Google drive.
sirLisko
Ссылка Блокнот в этом ответе запускает загрузку файла RAR. Почему нет веб-страницы, разве вы не сказали, что это браузерный редактор?
evanrmurphy
эта ссылка больше не действительна
Карлос Плиего
Просто указав, что это не полный ответ на вопрос. Вы не объясняете, что такое .md, только как его можно отредактировать
Zoe
33

Текстовый редактор кода Microsoft Visual Studio имеет встроенную поддержку файлов .md, написанных в синтаксисе уценки.

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

Чтобы увидеть их рядом, перетащите вкладку предварительного просмотра в правую часть редактора или используйте вместо нее Ctrl+K V(Windows) или Cmd+K V(Mac).

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

VS Code использует отмеченную библиотеку для синтаксического анализа, и по умолчанию включена поддержка Github Flavored Markdown , но он не будет отображать встроенный Github Emoji, как это делает текстовый редактор Github Atom .

Кроме того, VS Code поддерживает несколько плагинов для разметки, доступных для расширенной функциональности.

Feckmore
источник
Если вы используете Visual Studio 2015, см. Мой ответ ниже.
bytedev
1
Примечание - вы можете щелкнуть правой кнопкой мыши файл readme> открыть предварительный просмотр
Крис Хэлкроу
15

Расширение « .md » относится к файлам Markdown .

Если вы не хотите устанавливать приложение для чтения их в этом формате, вы можете просто использовать TextEdit или сам Xcode , чтобы открыть его на Mac.

В любой другой ОС вы сможете открыть его с помощью любого текстового редактора , хотя, как и ожидалось, вы не увидите его в формате Markdown .

codeburn
источник
4
На самом деле, вы будете видеть его в формате Markdown. Вы не увидите его жирным шрифтом, курсивом, отступами и блоками кода.
Гонки легкости на орбите
14

Да, просто GitHub со вкусом Markdown . Включение файла README в ваш репозиторий поможет другим быстро определить, о чем он и как его установить. Очень полезно включить в свои репозитории.

esilvas
источник
5
Downvoted. Под «один» в «включении одного в ваш репозиторий» вы должны понимать «файл README в любом формате», а не просто «файл README.md». Но вопрос касается файлов «.md» в целом, а не файлов README в целом. Так что этот ответ не имеет отношения к вопросу. Кроме того, двусмысленность с «одним» может заставить читателя думать, что README Markdown обязательно лучше, чем другие README, что неправильно.
Рори О'Кейн
1
Я внес изменения, указанные в предыдущем комментарии, потому что это имеет смысл, и я думаю, что это поможет избежать путаницы. Я не думаю, что это очень хороший ответ, поскольку он не добавляет ничего нового, что имеет отношение к делу. Этот вопрос не о README, а о расширении .md. Нет причин добавлять этот ответ через шесть недель после того, как принятый ответ предоставил ту же информацию.
Эрик Робертсон
5

Stack Edit - это онлайн редактор уценок с возможностью сохранения в Google Drive и DropBox.

Филипп
источник
5

Markdown - это просто текстовый файл, который по желанию имеет .mdили имеет .markdownрасширения. Это может быть преобразовано в HTML. Чтобы узнать синтаксис Markdown, Проверьте

GitHub Ароматизированная уценка .

Вы можете использовать любой текстовый редактор для уценки. Если вы sublime textпользователь, вы можете проверить Markdown Previewплагин, который будет отображать отображаемый контент уценки в браузере и обновлять каждый раз, когда вы изменяете файл уценки.

Некоторые из онлайн-редактор уценки

Физер Хан
источник
3

Я предлагаю StackEdit . Это простой редактор WISIWIG. Вы можете использовать как редактор, так и синтаксис уценки. Там есть быстрый синтаксис справки по уценке. Отменить / повторить, комментарии, GoogleDrive, соединение Dropbox.

Romeno
источник
2

markable.in - очень хороший онлайн-инструмент для редактирования синтаксиса Markdown.

user1337432
источник
2

Если вы создаете файлы .md для своих решений .NET, я рекомендую редактор разметки расширения Visual Studio 2015, поскольку он имеет панель предварительного просмотра, чтобы вы могли видеть ваши изменения в режиме реального времени.

РЕДАКТИРОВАТЬ : Это также теперь должно работать с Visual Studio 2017.

bytedev
источник
0

Если у вас нет устройства для чтения, проще всего открыть файл MD в текстовом редакторе, а затем записать файл MD в виде файла HTML, а затем дважды щелкнуть его, чтобы просмотреть его в браузере.

richardwendrock
источник
Это будет работать, только если у вас есть плагин, который читает файлы .md.
Брэд Брюс
0

.Md расшифровывается как Markdown Text. По сути, это просто другой тип текстового файла, например .txt

Я использую Notepad ++ для чтения и редактирования этих

NocFenix
источник