From 1b00696bccac29f24328a65c78a345e6ccba98ba Mon Sep 17 00:00:00 2001 From: tastytea Date: Tue, 31 Jan 2023 22:01:50 +0100 Subject: [PATCH] document /cmark and Markdown extensions in man page (#1344) * document /cmark in man page * document Markdown extension in man page * fix spoiler wording Co-authored-by: DeepBlueV7.X --------- Co-authored-by: DeepBlueV7.X --- man/nheko.1.adoc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/man/nheko.1.adoc b/man/nheko.1.adoc index d2eacbd4..827c8510 100644 --- a/man/nheko.1.adoc +++ b/man/nheko.1.adoc @@ -160,6 +160,12 @@ Send a message as a reaction when you’re replying to a message. */md* __:: Force Markdown when sending the current message. +*/cmark* __:: +Disables most of our extensions to cmark (CommonMark), including the +newline-in-input = newline-in-output behaviour, strikethrough and spoilers. You +may still force newlines with 2 spaces or a backslash before the line ending or +insert HTML elements. + */plain* __:: Force plain text when sending the current message. @@ -253,6 +259,18 @@ Converts a room to a direct conversation. */converttoroom*:: Converts a direct conversation to a normal room. +== MARKDOWN EXTENSIONS + +*newline (+\n+)*:: +A single newline will be turned into `
` instead of a space. + +*+~~text~~+*:: +Make text strikethrough. HTML putput: `text` + +*`||spoiler|text||`*:: +Hide text and set an optional spoiler. Note that Nheko does not display the +spoiler warning currently. HTML output: `text` + == FILES *Configuration file*::