Commit Diff

Commit:
e678f0f29294a33d774f58298da8658035b1e6cb
From:
Murilo Ijanc <murilo.ijanc@kovi.com.br>
Date:
Message:
Document the Slack mrkdwn formatting that is handled server-side. sm transmits the message body verbatim and Slack renders it using its own mrkdwn variant, which is similar to but not identical to CommonMark. Add a matching FORMATTING section to README.md and sm.1 pointing at the upstream reference so callers do not assume CommonMark syntax. Also exclude the local channels scratch file from the working tree.
Actions:
Patch | Tree
commit - 6f43b0407ec7a6da3018fd81c2d678c078d1f84a
commit + e678f0f29294a33d774f58298da8658035b1e6cb
blob - 411a5b8a437447565a9a48f32fde3c2aed94b004
blob + 9d32ecd98d729027e4a3f7f2a8693ad58aae8d4d
--- .gitignore
+++ .gitignore
@@ -1,2 +1,3 @@
 build
 vendor
+channels
blob - 3c35f083919b51bec4fc339989ec8d4ba835e4b3
blob + 713e36615cccf83123c9e9e350e9b59df47de6dd
--- README.md
+++ README.md
@@ -35,6 +35,17 @@ Print the version:
     sm -V
 
 
+Formatting
+----------
+sm sends the message bytes verbatim.  Slack renders the text as
+its own mrkdwn flavor on the server side; the syntax is similar
+to but not identical to CommonMark (e.g. `*bold*` instead of
+`**bold**`).  See the Slack formatting reference for the full
+list:
+
+    https://api.slack.com/reference/surfaces/formatting
+
+
 Configuration
 -------------
 sm reads a single environment variable:
blob - 78d449e4670be777d3c063b261a568bbdf260c56
blob + f796de77ad1b133e4e8f4c2773d8712cb784b8b8
--- sm.1
+++ sm.1
@@ -60,6 +60,17 @@ The options are as follows:
 .It Fl V
 Print the version and exit.
 .El
+.Sh FORMATTING
+.Nm
+transmits the message body verbatim.
+Slack renders the text as its own
+.Dq mrkdwn
+flavor on the server side; the syntax is similar to but not
+identical to CommonMark
+.Pq e.g. Li *bold* No instead of Li **bold** .
+See
+.Lk https://api.slack.com/reference/surfaces/formatting
+for the full reference.
 .Sh ENVIRONMENT
 .Bl -tag -width SLACK_USER_TOKEN
 .It Ev SLACK_USER_TOKEN