Sun May 24 2020

...

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

Более насыщенный опыт комментирования пришел в FastComments с использованием Markdown!

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

Вот шпаргалка по 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.53kb до 9.12kb — что означает более быстрое время загрузки страниц.

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

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

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

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

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