2016-09-18 4 views
3

Github «использует« github flavored markdown », но я не смог точно определить, что это значит. Какую библиотеку разбора они используют на клиенте для предварительного просмотра?В какой библиотеке используется Github для разборки меток?

Является ли тот же lib использован для * .md файлов, выпусков и страниц вики?

Бонусные баллы, если вы можете указать мне ресурс, который показывает, как уценка github и совпадение обычных символов и как они отличаются.

ответ

2

Назовите меня ресурсом, который показывает, как угасание github приспосабливается и совпадение обычаев и как они отличаются.

Это сейчас (март 2017) официально задокументированы: см «A formal spec for GitHub Flavored Markdown»

Начиная с сегодняшнего дня, все содержимое пользователя Markdown размещается на нашем сайте, включая комментарии пользователей, вики и .md файлов в хранилищах будут проанализированы и представлены следующим образом: formal specification for GitHub Flavored Markdown.

Это подробно описано в «A formal spec for GitHub Flavored Markdown»

Эта формальная спецификация базируется на CommonMark, амбициозный проект, формально указать синтаксис Markdown, используемый многими сайтами в Интернете, таким образом, что отражает его реальное использование в мире.
CommonMark позволяет людям продолжать использовать Markdown так же, как и всегда, предлагая разработчикам всестороннюю спецификацию и эталонные реализации для взаимодействия и отображения Markdown последовательно между платформами.

Идея такова:

Принимая CommonMark спецификации и переразработки наш текущий стек пользовательского контента вокруг него не является тривиальной задачей.
Основная проблема, с которой мы боролись, заключается в том, что спецификация (и, следовательно, ее эталонные реализации) сосредоточена строго на общем подмножестве Markdown, который поддерживается оригинальной реализацией Perl.
Это не включает некоторые из расширенных функций, которые всегда были доступны в GitHub. В частности, отсутствует поддержка таблиц, зачеркиваний, автолинков и списков задач.

Чтобы полностью указать версию Markdown, которую мы используем в GitHub (известный как GFM), нам пришлось формально определить синтаксис и семантику этих функций, чего мы никогда раньше не делали. Мы сделали это поверх существующей спецификации CommonMark, уделяя особое внимание тому, чтобы наши расширения были строгим и необязательным дополнением к исходной спецификации.

3

Markup является «Код, который мы [Github] используем для рендеринга README.your_favorite_markup». Они перечисляют Redcarpet как свою библиотеку для Markdown. Это, в свою очередь, использует Sundown. Независимо от того, используется ли это для всего сайта, я не уверен.

Он также утверждает, что имеет «массивную поддержку поддержки».

Sundown имеет дополнительную поддержку для нескольких (неофициальных) расширений Markdown, таких как нестрогий акцент, блокированные кодовые блоки, таблицы, автолинки, зачеркивание и многое другое.

Для полной информации вам, возможно, придется вникнуть в эти библиотеки.

Бонусные баллы, если вы можете указать мне на ресурс, который показывает, как GitHub ароматизированный уценки и commonmark перекрытия и как они отличаются.

Sundown утверждает, что «полностью соответствует стандартам» с Markdown v1.0.0 и v1.0.3, но для жизни меня я не могу найти эти версии. Только v1.0.1 и CommonMark, что на 0,26.

Sundown выходит из коробки официальных Markdown v1.0.0 и v1.0.3 тестов сьютов, и был тщательно протестирован с дополнительными угловыми случаями, чтобы убедиться, что его выход как нормальный, насколько это возможно в любое время.

Расширения Github Markdown - documented in their Mastering Markdown guide.