Розширення файлу для файлів Markdown?


116

Чи є офіційне розширення файлу для автономних файлів Markdown?


8
Хтось використовує filename.md.txtтак само, як і filename.rst.txt? Це вказує, що це формат розмітки, але також повертається до простого тексту, якщо у вас немає чого обробляти розмітку. GitHub визнає .rst.txt, але не .md.txt: gist.github.com/2770487
ендоліти

1
Якщо ви плануєте зберігати ці файли на машині Windows, то я б дотримувався розширення <= 3 символи. Це робить .mdі .mkdєдиним часто використовуваним варіантом. З них .mdППД більш популярний, тому я настійно пропоную скористатися цим. Не турбуйтеся про файли дескрипторів машини; вони не так широко використовуються, і їх слід ідеально редагувати в редакторі Markdown (просто ігноруйте частину попереднього перегляду редактора).
krowe2

Відповіді:


109

Немає вимоги до розширення файлу Markdown, як пояснили інші відповіді. Але для того, щоб редактори чи парсери гарантували, що файл, який вони використовують, має формат Markdown, вони шукають одне з наступних розширень:

.markdown
.mdown
.mkdn
.md
.mkd
.mdwn
.mdtxt
.mdtext
.text
.Rmd

Є веб-сайти, такі як GitHub, які використовують лише перелік цих розширень для перетворення в HTML, щоб розробники відповідали їхньому стандарту. (див. приклади нижче)

Особисто я бачив .markdown і .mdown використовували найбільше, і як користувач Linux , я б не використати .md як це також може бути м achine d ПИСАНИЕ файл для компіляції коду з GCC.


Приклади використання розширень:

GitHub : відмітка, mdown, mkdn, mkd, md ( джерело )

Елементи Markdown Editor: розмітка, mdown, mdwn, md

Вім уцінки : уцінки, mdown, mkdn, mdwn, мкд, мкр

Bitbucket : розмітка, mdown, mkdn, mkd, md, текст ( джерело )

R Studio : Rmd


Подальше читання

Існує список розсилки Markdown , який цікаво обговорює цю тему: 1 , 2 .

І особливо показовим є одне з пояснень:

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

У цьому сенсі має сенс використовувати ".text", ".txt" або будь-яке інше розширення простого тексту.
...
Редактор, який нічого не знає про Markdown, не піклується про метадані і не буде плутати різноманітність "нестандартних" розширень, але просто відображатиме та редагуватиме непростий текст.


Bitbucket використовує md, mkdn, markdown: confluence.atlassian.com/display/BITBUCKET/…
Ренді Сирінг

.md і .markdown є найбільш поширеними розширеннями, які використовуються в цей момент.
Крістофер Барбер

Невелике оновлення на продовженнях визнаних GitHub, здається , список зріс трохи: md, mkd, mkdn, mdwn, mdown, markdown- джерело
Роберт Audi

16

Ідея MarkDown та подібних невеликих розміток повинна бути зрозумілою як звичайний текст, таким чином, вони мають текст / просте розширення ( .txtабо .text).

Однак є деякі люди, які використовують .markdownабо .mdown.


2
Тільки для запису, Elements для iPhone розпізнає .md, .markdown, .mdown, .mdwn та .text
Beat Rupp

4
vim 7.3 розпізнає .markdown та .mdown, тому .markdown є найбільш описовим.
Мартін Удінг

1
Kohana використовує .md
Ліам Доусон

3
Я також бачив пару .md в GitHub, і мій Vim в офісі визнає це як Маркдаун (я повинен перевірити, чому його немає вдома).
Wernight

1
Ця відповідь не настільки обширна / повна, як та, яка має найбільше голосів.
svandragt

3

Мені про це не відомо, але я думаю, що прецедентом встановлено використання .textрозширення на офіційному веб-сайті для виявлення Markdown, який створює сторінки.


3
Однак те, що офіційний веб-сайт використовує це, не означає, що це гарна ідея. .textозначає звичайний текст, а не розмітку.
ендоліт



1

Словом, відповідь - ні.

Якщо ви просто використовуєте файли розмітки як автономні файли, які не будуть оброблятися жодним чином, назвіть їх, як не завгодно. Якщо ви використовуєте їх у системі, обробляє їх у HTML чи PDF чи інший формат, то вам потрібно розібратися, які розширення файлів очікує система для файлів розмітки.

Також у контексті системи UNIX розширення файлів навіть не є обов'язковими. Ви можете просто мати файл під назвою "README" у форматі розмітки.


Але fileскажу лише, що це текст ASCII, який не говорить мені про те, що я можу його пропустити markdown.
Мартін Удінг

1

Як додаток до дуже доброї відповіді Каса, я хотів би зазначити, що його посилання на сховище github Vim markdown дещо застаріле.

Plasticboy користувач був оригінальним творцем Vim Markdown , але в даний час розроблені і завантажені на сайті VIM сценаріїв по Hallison Батісти і інші.

Наприклад, один користувач зробив роздріб для підтримки посилань Gollum.


0

Хм ... Гені, IDE з відкритим кодом, зберігаючи відформатований файл Markdown, використовує .mdmlрозширення. Дивно, що він, здається, єдиний ...

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