Discourse Mark Plugin

discourse-mark

Repository: GitHub - sirideain/discourse-mark: Adds highlighting to Discourse

Features

  • Adds an editor option to highlight text.

Usage

You can wrap text with == to highlight it.

==Highlighted Text==

Installation

Known Issues

  • None

Future

  • Update icon to highlighter once Font Awesome 5 is available
27 лайков

This is already sort of possible in default Discourse with HTML tags

inserted text and deleted text

<ins>inserted text</ins> and <del>deleted text</del>

Not quite the same as “highlighted” but a very similar effect at least for <ins>

10 лайков

I think @sirideain put this together following this thread: Discourse CommonMark text highlighting?

2 лайка

Yes totally fine, just pointing out there’s an alternative “sort-of” way to do this built in. I don’t think Commonmark even specifies highlight as part of the standard…

1 лайк

I think they’re fundamentally different things though? Insertions and deletions may be used in parallel with highlighting.

That’s a very literal reading. If I was to tell you I just highlighted this text how would anyone reading even know any different? Particularly if I changed the CSS to whatever color and style I liked…

2 лайка

Highlighting indicates areas for attention, insertions and deletions indicate change.

Sure, we can use CSS to restyle elements, we could also for example set background-color on anything within <strong> tags, but then we would lose the ability to make things bold without also highlighting them. The plugin lets us highlight passages without losing differentiation between the styles associated with tracked changes. Being a totally optional plugin which expands upon a well-established convention I don’t see tremendous value in confusing the two.

1 лайк

It is not part of the commonmark spec, that is for sure.

It would be great if this followed other common Markdown highlight syntax. I’m not sure if it’s in a particular spec (a quick Google search didn’t yield anything), but popular Markdown apps with the highlight feature use double colons to enclose text, like so:

::Highlighted Text::

Love the idea though!

2 лайка

Discourse is using markdown-it for parsing markdown. I am bundling the markdown-it-mark plugin so it is available in Discourse. Support for this syntax would need to be added there.

5 лайков

I installed this, and the ==text== highlighting works, but the Highlight Text option does not show up in the gear menu.

Curiously the Green Tick does not show next to the plugin either:

but I don’t know if that is related.

The green tick will only appear next to official plugins that are supported by the core discourse team, to distinguish them from 3rd party plugins.

6 лайков

There was an issue where the highlighting was not respecting the enable setting, but the gear menu option was. This has been fixed now.

Этот плагин, похоже, нарушает работу публикации в Discourse 2.6. По крайней мере, публикация не удавалась с ошибкой 500, пока я не удалил этот плагин и не пересобрал свой форум.

Я только что протестировал с чистой установкой 2.7 beta1, и всё работает корректно. Какие ещё плагины у вас установлены? Есть ли что-то в логах Discourse?

Смотрите:

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

Остальные плагины являются официальными продуктами Discourse.

Я попробовал добавить другие указанные вами плагины, но не смог воспроизвести проблему.

Не удивительно, что в логах упоминается markdown, так как он используется для всего форматирования в постах Discourse. Я не заметил никаких упоминаний этого плагина в присланных вами логах.

Что произойдёт, если вы снова добавите плагин и выполните пересборку? Мне кажется, ваша версия о том, что проблема в пересборке, верна.

Я попробую это сделать и вернусь к вам с ответом. Возможно, у меня не получится сделать это сегодня; мне нужно будет заняться этим, когда у меня будет время, чтобы внимательно отследить процесс.

Спасибо за обратную связь.

Я переустановил плагин mark, и всё кажется в порядке. Похоже, какая-то комбинация удаления плагина и пересборки устранила проблему с невозможностью публикации, а повторная установка плагина и пересборка не вернули систему к состоянию сбоя.

Не знаю, что это значит, но я рад, что плагин снова работает.

Спасибо.

Есть ли способ добавить ярлыки стилизации на панель инструментов редактора сообщений? Существует множество тегов, которые улучшили бы понимание технических тем. Однако новички, с другой стороны, разочарованы аскетичностью панели инструментов Discourse.

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

И поскольку мы занимаемся поддержкой программного обеспечения силами сообщества, была бы полезна настраиваемая группа эмодзи (вынесенная наверх/по умолчанию). (Мы бы добавили группу эмодзи по теме технологий.)

вставленный код : <ins>вставленный код</ins>
удалённый код : <del>удалённый код</del>
выделенный текст : <mark>выделенный текст</mark>
Клавиши клавиатуры Ctrl+k : <kbd>Ctrl</kbd>+<kbd>k</kbd>

Технологические эмодзи включают устройства ввода, такие как мышь и клавиатура.
:computer_mouse: Компьютерная мышь

4 лайка