diff options
| author | tastytea <github@tastytea.de> | 2023-01-31 22:01:50 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-31 21:01:50 +0000 |
| commit | 1b00696bccac29f24328a65c78a345e6ccba98ba (patch) | |
| tree | 763025d39eff49cd684aca040fb80f746dedf037 | |
| parent | ee5b33978a71ea794bd359e59b628baf39d39bb9 (diff) | |
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 <nicolas.werner@hotmail.de>
---------
Co-authored-by: DeepBlueV7.X <nicolas.werner@hotmail.de>
| -rw-r--r-- | man/nheko.1.adoc | 18 |
1 files changed, 18 insertions, 0 deletions
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* _<message>_:: Force Markdown when sending the current message. +*/cmark* _<message>_:: +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* _<message>_:: 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 `<br>` instead of a space. + +*+~~text~~+*:: +Make text strikethrough. HTML putput: `<del>text</del>` + +*`||spoiler|text||`*:: +Hide text and set an optional spoiler. Note that Nheko does not display the +spoiler warning currently. HTML output: `<span data-mx-spoiler="spoiler">text</span>` + == FILES *Configuration file*:: |