Является ли синтаксис уценки универсальным?

Я установил гем Red Carpet и реализовал его в своем приложении rails. Однако в его файле readme на самом деле нет никакой информации о синтаксисе.

Должен ли синтаксис быть очевидным? Вся уценка git hub, по-видимому, успешно проанализирована в ожидаемый html в моем приложении, так что могу ли я использовать уценку git hub в качестве ресурса для написания readme для моего собственного приложения? Или есть небольшие изменения, и мне придется проверять каждый заголовок, пункт списка и пометку?

Если синтаксис не универсален, то каков синтаксис уценки Red Carpet?


markdown redcarpet
person Starkers    schedule 20.05.2014    source источник
comment
Только к вашему сведению: мало того, что синтаксис разных парсеров MD немного отличается (например, зачеркивания нет в исходных спецификациях Джона Грубера), но каждая реализация может иметь свои собственные ошибки и/или порядок обработки, поскольку Что ж. См. johnmacfarlane.net/babelmark2/faq.html.   -  person Jongware    schedule 21.05.2014
comment
Должен был знать! Не беспокойтесь, когда я пишу элементы управления jquery, я осмелюсь сказать, что я очень устарел со способом работы Red Carpet.   -  person Starkers    schedule 21.05.2014
comment
Основной/исходный синтаксис задокументирован на daringfireball.net/projects/markdown/syntax. Кроме того, это зависит от того, какие расширения< /i> вы решите включить.   -  person Jonathan Lonowski    schedule 21.05.2014

Ответы (1)


arrow_upward
2
arrow_downward

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

Несколько реализаций Markdown (Reddit, GitHub и т. д.) представили свой собственный дополнительный синтаксис, а иногда и некоторые настройки того, как особые случаи имеют смысл для их случаев. Обычно это задокументировано — вот схема GitHub того, что они добавили и изменили. Как упомянул @Jonathan Lonowski, у RedCarpet, похоже, есть несколько расширений, которые вы можете выбрать, изменить или добавить поведение, в зависимости от ваших потребностей.

person cincodenada    schedule 20.05.2014