Как узнать, нужно ли мне использовать библиотеку Markdown?

Question

Я обнаружил, что многие проекты Github используют Markdown . Первоначально я думал, что эта библиотека нужна только на сайтах, таких как StackOverflow, которые предоставляют пользователям возможность добавлять комментарии или публикации, которые могут содержать фрагменты исходного кода. Но некоторые приложения, похоже, используют Markdown, даже если это не так.

Markdown - легкая разметка язык, изначально созданный Джоном Грубер и Аарон Шварц, чтобы помочь максимальная читаемость и «публикуемость» как его вклада, так и выходные формы. Язык занимает много реплики из существующих конвенций для разметка простого текста в электронном письме. Уценка преобразует размеченный текст ввод в действительный, правильно сформированный XHTML и заменяет левые угловые скобки ('<') и амперсанды с их соответствующий персонаж ссылки. </p>

В настоящее время я пишу веб-приложение, которое позволяет пользователям добавлять комментарии. Возможно ли, что я должен использовать Markdown для этого - даже если комментарии не содержат исходный код?

Answer 1

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

В любом случае, вопрос, который вам нужно задать себе, в данном случае: вы хотите, чтобы ваши пользователи могли форматировать комментарии? Если да, вам нужна некоторая библиотека форматирования. Уценка может быть хорошей идеей тогда. Это соответствует тому, как люди в любом случае размечают текстовые среды, например, окружают выделенный текст звездочками или подчеркиванием.

Это также своего рода защита, поскольку она заменяет разметку HTML сущностями, в основном предотвращая атаки сценариев.

Answer 2

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