2013-08-02 2 views
7

Это было тайной для меня какое-то время, и почему-то Google не помог мне, поэтому позвольте мне спросить.Где GitHub Flavored Markdown (GFM), фактически используемый в GitHub?

EDIT: хорошо, я понимаю, что GFM повсюду в GitHub, и почему редактирование строки в стиле GFM недоступно? Он выключен? и я знаю оригинальное правило MD. Что я хотел бы подтвердить здесь, это правило разрыва строки GFM. Спасибо.

Мне очень нравится GFM, особенно для линейного прерывания линии. https://help.github.com/articles/github-flavored-markdown Однако я никогда не мог опубликовать свой собственный Markdown с этим режимом линии клюва.

Например, я скопировал список синтаксического списка MD на новую страницу одной из моих вики на GitHub.

https://github.com/kenokabe/kenokabe.github.io/wiki/MarkDownGFM

Как вы можете подтвердить источник MD.

This is intended as a quick reference and showcase. 
For more complete info, see [John Gruber's original spec] 

применяется одна новая линия; однако результат показан без новой строки.

Что мне не хватает? Где GitHub Flavored Markdown (GFM) фактически используется в GitHub?

(Техническое примечание: Markdown Здесь используется разрывы GFM линии, так что нет никакой необходимости использовать перерывы два-космическую линию МДА.)

Это, конечно, говорит, что это так, но я нашел, что это мД использует 2 пространств BR способ ,

+0

Возможно, вы захотите изменить заголовок вопроса, чтобы отразить его новый контент. –

ответ

10

В отличие от других ответов, GFM является только используется там, где текст только вошел через сайт GitHub, а не в README.md, а не на GitHub Wikis.

Из https://help.github.com/articles/github-flavored-markdown (курсив добавлен)

GitHub использует то, что мы называем "GitHub ароматизированный Markdown" (GFM) для сообщений, вопросы и комментарии.

Смысл этого в том, что README.md и Wikis являются частью Git репозиториев, и, следовательно, могут быть клонированы за пределами площадки, где можно было бы разумно ожидать (стандарт) Markdown, а не GFM.

Более подробно об обосновании GitHub, см https://github.com/github/markup/issues/208#issuecomment-24927799

Edit:

подсветка синтаксиса (Pygments) отделена от GFM, в том, что GFM использует подсветку синтаксиса, однако наличие подсветки синтаксиса не влекут за собой GFM, поэтому почему GitHub Pages будет использовать стандартные разрывы Markdown: он использует Pygments, но не GFM.

+0

Спасибо. Вот что я думал и хотел подтвердить. Фактически, я планировал сделать какую-то страницу, например https://github.com/substack/stream-handbook, для вывода для себя, но обнаружил, что трудно редактировать с помощью разрыва строки без GFM. В конечном итоге я разработал свою собственную систему управления контентом. –

0

Используется при отображении файла README.md на главной странице вашего репозитория, for example. Кроме того, когда вы добавляете комментарии, это GFM.

+1

Он также используется для 'Github Pages' и может быть интерпретирован с помощью Jekyll' и переведен на html. WAY лучше, чем писать прямые html, IMO. – Houdini

+1

@ Хоудини, да, почти везде на сайте, не так ли? –

+0

https://github.com/kenokabe/heroku-buildpack-nodejs/blob/master/README.md Это часть моего README.md, и я просто попробовал Hello/nWorld в начале. Понимаю. Что мне не хватает? –

0

GitHub ароматизированные уценки используются на:

  • файл риого вашего репо
  • любых .md файлов в репозитории
  • вопросов
  • вики & страницы

и минимально на комментарии (фиксация, запросы на тягу и т. д.)

примечание о проблемах: похоже, что он использует ограниченную версию GFM, чем на страницах вики или файлах readme.

+0

Спасибо @xero, есть ли у вас какие-либо идеи о том, почему стиль GFM для определенных строк не применяется к ним? –

+1

np. нет, я не уверен. для комментариев я предполагаю, что это по тем же причинам, почему они не позволяют многострочные комментарии здесь. это нормально в контексте ответа, но не в контексте комментариев. – xero

Смежные вопросы