Diff

mod_pastebin/README.markdown @ 4315:87e250409998

mod_pastebin: Normalize markdown [fix] md:command=pandoc -f markdown-smart+emoji -s -t markdown-smart+emoji+pipe_tables+simple_tables-multiline_tables-grid_tables-raw_html md:pattern=set:**.md + **.markdown
author Kim Alvefur <zash@zash.se>
date Sat, 02 Jan 2021 15:28:45 +0100
parent 3484:ce89fabb1f02
child 4316:4bba01ce2f98
line wrap: on
line diff
--- a/mod_pastebin/README.markdown	Wed Dec 30 18:44:54 2020 +0100
+++ b/mod_pastebin/README.markdown	Sat Jan 02 15:28:45 2021 +0100
@@ -1,11 +1,10 @@
 ---
 labels:
-- 'Stage-Stable'
-summary: 'Redirect long messages to built-in pastebin'
-...
+- Stage-Stable
+summary: Redirect long messages to built-in pastebin
+---
 
-Introduction
-============
+# Introduction
 
 Pastebins are used very often in IM, especially in chat rooms. You have
 a long log or command output which you need to send to someone over IM,
@@ -14,10 +13,9 @@
 
 Not for everyone... no matter how hard you try, people will be unaware,
 or not care. They may also be too lazy to visit a pastebin. This is
-where mod\_pastebin comes in!
+where mod_pastebin comes in!
 
-Details
-=======
+# Details
 
 When someone posts to a room a "large" (the actual limit is
 configurable) message, Prosody will intercept the message and convert it
@@ -25,10 +23,9 @@
 generated, so they can be considered for most purposes to be private,
 and cannot be discovered by people who are not in the room.
 
-Usage
-=====
+# Usage
 
-To set up mod\_pastebin for MUC rooms it **must** be explicitly loaded,
+To set up mod_pastebin for MUC rooms it **must** be explicitly loaded,
 as in the example below - it won't work when loaded globally, as that
 will only load it onto normal virtual hosts.
 
@@ -47,30 +44,27 @@
 or you can forward another external URL from your web server to Prosody,
 use `pastebin_url` to set that URL.
 
-Configuration
-=============
+# Configuration
 
-  Option                      Description
-  --------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-  pastebin\_threshold         Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters)
-  pastebin\_line\_threshold   The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)
-  pastebin\_trigger           A string of characters (e.g. "!paste ") which if detected at the start of a message, always sends the message to the pastebin, regardless of length. (default: not set)
-  pastebin\_expire\_after     Number of hours after which to expire (remove) a paste, defaults to 24. Set to 0 to store pastes permanently on disk.
-  pastebin\_ports             List of ports to run the HTTP server on, same format as mod\_httpserver's http\_ports[^1]
-  pastebin\_url               Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server[^2]
+  Option                    Description
+  ------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+  pastebin_threshold        Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters)
+  pastebin_line_threshold   The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)
+  pastebin_trigger          A string of characters (e.g. "!paste ") which if detected at the start of a message, always sends the message to the pastebin, regardless of length. (default: not set)
+  pastebin_expire_after     Number of hours after which to expire (remove) a paste, defaults to 24. Set to 0 to store pastes permanently on disk.
+  pastebin_ports            List of ports to run the HTTP server on, same format as mod_httpserver's http_ports[^1]
+  pastebin_url              Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server[^2]
 
-Compatibility
-=============
+# Compatibility
 
-  ----- -------
-  0.11  Works
-  0.10  Works
-  0.9   Works
-  0.8   Works
-  ----- -------
+  ------ -------
+  0.11   Works
+  0.10   Works
+  0.9    Works
+  0.8    Works
+  ------ -------
 
-Todo
-====
+# Todo
 
 -   Maximum paste length
 -   Web interface to submit pastes?
@@ -79,4 +73,4 @@
     see [Prosody HTTP server documentation](https://prosody.im/doc/http)
 
 [^2]: See also
-    [http\_external\_url](https://prosody.im/doc/http#external_url)
+    [http_external_url](https://prosody.im/doc/http#external_url)