Rich Text support in Hyperkitty
Hi All,
I have been recently working on adding rich text support through markdown in Hyperkitty so that emails can be made easier to read. The core design idea in my mind when working on this was building something that doesn't bother writers of plain text emails too much, but allows people to write emails in markdown.
The supported syntax is limited Markdown, for example:
Hyperkitty's Markdown Syntax
- List items are supported
- Even nested ones
- Headers with
#aren't supported, mostly due to their widespread use as comments in code shared on mailing lists. - You can **emphasize** text and _itcalize_ them too
- Block code and
inline codeworks. - URLs work like they usually do.
- Images _do work_, but are disabled by default because of their potential for tracking users. They need to be enabled by administrators through a configuration flag.
def sample():
return "yay"
While text intentionally written for Markdown rending looks pretty good, plain text sometimes isn't as good. I have applied my branch1 on both the Mailman installations for these two lists (mail.python.org & lists.mailman3.org).
Any feedback or bug reports on weird looking stuff is welcome here or directly on my PR
-- thanks, Abhilash Raj (maxking)
Am 13. Juni 2019 um 23:22 Uhr -0400 schrieb Abhilash Raj:
- Block code and
inline codeworks.
I'd say to not accept inline code this way, because I perceive it as way
to common to use this' kind of quoting. If the leading is taken as
the beginning of an inline code element, it will break the formatting of
everything that follows.
-- Blog: https://mg.guelker.eu
On Fri, Jun 14, 2019, at 11:07 AM, Marvin Gülker wrote:
Am 13. Juni 2019 um 23:22 Uhr -0400 schrieb Abhilash Raj:
- Block code and
inline codeworks.I'd say to not accept inline code this way, because I perceive it as way to common to use
this' kind of quoting. If the leadingis taken as the beginning of an inline code element, it will break the formatting of everything that follows.
I would actually like inline code to work, it is quite helpful actually when reading, although I agree with your point.
The rendering of the above message broke the formatting of only that line since inline style ended when it encountered a new-line character. Not to say that it isn't bad.
-- Blog: https://mg.guelker.eu
Mailman-users mailing list -- mailman-users@mailman3.org To unsubscribe send an email to mailman-users-leave@mailman3.org https://lists.mailman3.org/mailman3/lists/mailman-users.mailman3.org/
-- thanks, Abhilash Raj (maxking)
On 6/14/19 11:27 AM, Abhilash Raj wrote:
The rendering of the above message broke the formatting of only that line since inline style ended when it encountered a new-line character. Not to say that it isn't bad.
Actually, there was a second backtick on the line that terminated it. I'm not sure if the newline would have in the absence of that.
-- Mark Sapiro <mark@msapiro.net> The highway is for gamblers, San Francisco Bay Area, California better use your sense - B. Dylan
On 6/14/19 10:27 PM, Mark Sapiro wrote:
On 6/14/19 11:27 AM, Abhilash Raj wrote:
The rendering of the above message broke the formatting of only that line since inline style ended when it encountered a new-line character. Not to say that it isn't bad.
Actually, there was a second backtick on the line that terminated it. I'm not sure if the newline would have in the absence of that.
Just out of `curiosity', I'm going to see if a new line does break the inline style.
If it does, the style above should end after 'break the'. If not, we'll see...
-- Mark Sapiro <mark@msapiro.net> The highway is for gamblers, San Francisco Bay Area, California better use your sense - B. Dylan
On 6/16/19 9:25 AM, Mark Sapiro wrote:
Just out of `curiosity', I'm going to see if a new line does break the inline style.
If it does, the style above should end after 'break the'. If not, we'll see...
Based on the above as viewed in HyperKitty, it seems even smarter than that. If there is only one, unmatched ` on a line, no style is applied. Testing further. The above line has only one backtick.
This line has a pair.
This line has `three.
This line has four backticks.
-- Mark Sapiro <mark@msapiro.net> The highway is for gamblers, San Francisco Bay Area, California better use your sense - B. Dylan
HI Abilash,
I really would like to have this markdown for my lists. How can I enable it? What configuration flag, and where to find it?
Our users in our context also want images, one of the prime reasons for me converting to Mailman. How can I turn that on?
Andrew
On 7/7/19 8:41 PM, Andrew Bernard wrote:
I really would like to have this markdown for my lists. How can I enable it? What configuration flag, and where to find it?
See <https://gitlab.com/mailman/hyperkitty/merge_requests/160> for the merge request that implements it, or see <https://gitlab.com/mailman/hyperkitty/merge_requests/160.diff> for the patch.
Our users in our context also want images, one of the prime reasons for me converting to Mailman. How can I turn that on?
Included in the patch is a new doc/rendering.rst file which describes the necessary setting. Of course, this requires the patch to be applied.
-- Mark Sapiro <mark@msapiro.net> The highway is for gamblers, San Francisco Bay Area, California better use your sense - B. Dylan
A long time since I have done patching.
Can you tell me where to run this patch? Which git project? Pardon my _complete_ dumbness.
Andrew
I'll answer my own question. It's a git diff of course, so
git apply 160.diff
in the hyperkitty directory.
Andrew
participants (4)
-
Abhilash Raj -
Andrew Bernard -
Mark Sapiro -
Marvin Gülker