Краткая аннотация

Markdown (маркдаун) — облегчённый язык разметки. Первоначально создан Джоном Грубером (англ. John Gruben) и Аароном Шварцем, целью которых являлось создание максимально удобочитаемого и удобного в публикации облегчённого языка разметки. Многие идеи языка были позаимствованы из существующих соглашений по разметке текста в электронных письмах. Реализации языка Markdown преобразуют текст в формате Markdown в валидный, правильно построенный XHTML и заменяет левые угловые скобки («<») и амперсанды («&») на соответствующие коды сущностей. Далее →

Почему BlackCrystal выбирает Markdown

• При заполнении сайта содержимым, пользователь может зараннее не быть знаком ни с Markdown, ни с HTML - просто выложить текст как он есть, разделяя параграфы. Синтаксис Markdown прост, его легко изучить.
• Для Markdown не нужны тяжелые WYSIWYG-редакторы и сложные фильтрации на сервере (данные не содержат стороннего HTML-кода порой пропускаемого WYSIWYG-редакторами). Практика показала, что с момента внедрения Markdown в наши текущие проекты количество ошибок с незакрытыми тегами не просто уменьшилось, а практически исчезло. Это самый веский повод использовать Markdown как основу для наполнения сайта материалами.
• Нам также нравится что вместе со своим скромным наборами правил Markdown легко совмещается с HTML-кодом. Для пользователей, которые могут использовать HTML и не делать ошибок это несравненный плюс.
• Текст в Markdown удобен для переводчика. Он, содержит мало непереводимого мусора (теги) и позволяет легко подсчитать объём данных. Как правило от переводчика приходит готовый к размещению на сайте текст, не требующий внимательной перепроверки и изменений.

BlackCrystal поддерживает Markdown

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

Как работает сервис

Чтобы организовать предпросмотр документа Markdown, пошлите POST-запрос вашей формы на адрес http://www.blackcrystal.net/lab/markdown/preview. Вот один из примеров реализации предпросмотра:

<form action="http://example.com/" method="POST">
<textarea name="msg" cols="50" rows="5">
BlackCrystal
============
«Show what you can. Learn what you don’t.»
</textarea><br />
<input type="submit" value="Preview" onclick="
  var a = [this.form.action,this.form.target];
  this.form.action='http://www.blackcrystal.net/lab/markdown/preview';
  this.form.target='_blank';
  this.form.submit();
  this.form.action=a[0];
  this.form.target=a[1];
  return false;" />
<input type="submit" value="Submit" />
</form>

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

Если в форме имеется несколько полей, то укажите нужное название после знака ?, например: http://www.blackcrystal.net/lab/markdown/preview?msg

Вызов можно делать и посредством AJAX запроса, в этом случае ответом от сервера будет только Markdown переведённый в HTML, без обычных заголовков страницы.

Ссылки на ресурсы по этой теме

• Markdown — страничка проекта Markdown
• Showdown — парсер Markdown на Javascript. Предпросмотр без запросов к серверу.
• Markitup — лёгкий WYSIWYG-редактор на jQuery, с поддержкой Markdown.