Какой файл использует расширение .md и как мне их редактировать? - PullRequest
842 голосов
/ 07 мая 2011

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

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

Где найти введение в .md файлы?

Ответы [ 15 ]

699 голосов
/ 07 мая 2011

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

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

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

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

84 голосов
/ 18 мая 2012

Если вы ищете редактор, я предлагаю вам использовать http://dillinger.io/. Это простой браузерный текстовый редактор, который может отображать Markdown на лету.

Однако, если вы предпочитаете приложение и используете OS X, вы можете попробовать Mou . Это довольно хорошо и полно примеров.

41 голосов
/ 26 мая 2014

Github's Текстовый редактор Atom имеет режим предварительного просмотра в реальном времени для файлов уценки.Сочетание клавиш CTRL+SHIFT+M.

. Его можно активировать из редактора с помощью привязки клавиш CTRL+SHIFT+M, и в настоящее время оно включено для .markdown, .md, .mkd, .mkdown и .ron файлы.

enter image description here

28 голосов
/ 29 июля 2016

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

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

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

enter image description here

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

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

15 голосов
/ 04 июня 2013

Расширение ' .md ' относится к Уценке файлов.

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

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

14 голосов
/ 29 июля 2012

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

5 голосов
/ 06 марта 2014

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

GitHub Flavored Markdown .

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

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

5 голосов
/ 14 февраля 2014

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

4 голосов
/ 04 октября 2012

BBEdit также будет отображать MD на Mac.

и вот плагин быстрого просмотра для отображения при предварительном просмотре.

2 голосов
/ 21 сентября 2016

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

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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...