Sun May 24 2020

...

FastComments теперь поддерживает Markdown

В FastComments появилась более богатая функция комментирования с использованием Markdown!

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

Вот cheat sheet по Markdown, предоставленная Github: https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf.

Какой синтаксис Markdown поддерживает FastComments?

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

FastComments всегда поддерживал изображения с помощью синтаксиса [img]...[/img]. Эта поддержка будет продолжаться, так как это легче понять, чем синтаксис Markdown.

Смешивание контента

Один комментарий может содержать все формы форматирования - markdown, ссылки, изображения, фрагменты кода и таблицы.

Избежание атак XSF/XSS

Ранее FastComments отправлял обычный текст по сети и разбирал его на клиенте. Теперь HTML отправляется по сети, и мы храним две версии каждого комментария в нашей базе данных для поддержки функционала, такого как редактирование комментариев.

Отправка HTML напрямую в комментарии имеет свои риски - поэтому все сгенерированные комментарии разбираются и очищаются, чтобы предотвратить межсайтовые и межфреймовые атаки.

Экспорт данных

При экспорте комментариев вы получите версию, которую пользователь увидел, когда он написал свой комментарий. Если вы хотите получить сырой HTML, свяжитесь с нами.

Проблемы производительности

Избыточность функций имеет привычку замедлять работу. Это не то, что мы хотим делать в FastComments. Добавление этой функции уменьшило размер нашего клиентского виджета примерно на 400 байт - с 9,53 кб до 9,12 кб - что означает более быстрые загрузки страниц.

Хотя теоретически эта функция может замедлить механизм сохранения комментариев, мы не наблюдали ухудшения производительности и, как всегда, мониторим наши API.

Как мне это получить?

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

Как и при всех релизах функций, мы ждем отзывов, и хотя у нас много автоматического тестирования... если вы заметите какие-либо проблемы - дайте нам знать!

Счастливого комментирования.