Skip to content

Commit

The chat guide explains formatting a message: the bar and how to show or hide it, every shortcut and the Markdown that does the same, what Enter, Shift+Enter and Ctrl+Enter do in a line, a list and a code block, how messages show (coloured code, links, never HTML), that messages are kept as Markdown for agents and edits while notifications show plain words, and how to edit your own message in place.

syntaqxcommitted Parent7db0199Browse files
1 file+73−20/1 viewed
+73−2
235235
236236 An address such as `me@example.com` is never read as a mention.
237237
238+## Format a message
239+
240+Messages can have bold, italic and struck-through words, links, inline
241+code, code blocks, lists and quotes. Format as you write, three ways:
242+
243+- **The formatting bar** above the text. **T** at the bottom left of the
244+ composer shows or hides it, and your choice is kept on that device. On a
245+ phone it starts hidden; when it is shown, swipe it sideways for the rest.
246+- **Shortcuts.** Select words, or start typing after one. The keyboard
247+ button at the end of the bar lists them too.
248+- **Markdown, typed inline.** It turns into its formatting as you type:
249+ `*bold*` becomes **bold** when you type the closing `*`.
250+
251+| Formatting | Shortcut (⌘ on a Mac) | Or type |
252+| --- | --- | --- |
253+| Bold | Ctrl+B | `*bold*` or `**bold**` |
254+| Italic | Ctrl+I | `_italic_` |
255+| Strikethrough | Ctrl+Shift+X | `~struck~` or `~~struck~~` |
256+| Link | Ctrl+K | Select words and paste an address over them |
257+| Inline code | Ctrl+Shift+C or Ctrl+E | `` `code` `` |
258+| Code block | Ctrl+Alt+Shift+C | ` ``` ` then Enter, or ` ```ts ` to name the language |
259+| Bulleted list | Ctrl+Shift+8 | `- ` at the start of a line |
260+| Numbered list | Ctrl+Shift+7 | `1. ` at the start of a line |
261+| Quote | Ctrl+Shift+9 | `> ` at the start of a line |
262+
263+**Ctrl+K** asks where the link goes, and for its text when nothing is
264+selected. On a link already, it changes the address or removes the link.
265+A link goes to a web address, an email address or a page on g1t; anything
266+else is refused. Undo (**Ctrl+Z**) takes formatting back off.
267+
268+### Enter and new lines
269+
270+| Key | In a line of text | In a list | In a code block |
271+| --- | --- | --- | --- |
272+| **Enter** | Sends | Adds an item; on an empty item, leaves the list | Adds a line; three in a row leave the block |
273+| **Shift+Enter** | Starts a new line | Adds an item | Adds a line |
274+| **Ctrl+Enter** | Sends | Sends | Sends |
275+
276+In a quote, Enter sends and Shift+Enter starts the next line of the quote.
277+
278+### What a message shows
279+
280+Every message, a person's or an agent's, is shown with its formatting.
281+Code blocks with a language g1t knows (`ts`, `rust`, `python`, `sh`,
282+`sql`, `json` and others) are coloured, and have a copy button. A web
283+address on its own becomes a link, and links open in a new tab. Headings
284+an agent writes show as a bold line, and a rule as a line across.
285+
286+Chat never shows HTML: `<b>` reads as typed. An image written in Markdown
287+shows as a link to it, not the image.
288+
289+### Messages are Markdown
290+
291+What you send is kept as Markdown, the formatting written as `**bold**`,
292+`_italic_`, `~~struck~~` and so on. That is what agents read and write,
293+and what you edit when you change a message, so formatting survives the
294+round trip. Text you paste without formatting, such as from a terminal, is
295+read as Markdown too; paste with **Ctrl+Shift+V** to keep it exactly as it
296+is. Notifications, pop-ups and browser notifications show a message's
297+words without the marks: `**Release** is _done_` reads *Release is done*.
298+
299+To show a character that would format, put a backslash before it: `\*`
300+shows `*`.
301+
238302 ## Agents in channels
239303
240304 Invite an agent to a channel the way you invite a person. Only agents of
343407
344408 ## Edit and delete
345409
346−You can edit or delete your own messages. An edited message says so. A deleted message is removed for everyone; replies under it stay.
347−A message can be up to 40,000 characters, and is written in Markdown.
410+You can edit or delete your own messages. On a computer, hover your message,
411+open its **⋯** and choose **Edit message**: it opens in the composer, in
412+place, with its formatting. Enter or **Save** keeps the change, Esc or
413+**Cancel** leaves it as it was. On a phone, press and hold the message and
414+choose **Edit**. An edited message says so. A deleted message is removed
415+for everyone; replies under it stay.
416+
417+A message can be up to 40,000 characters, and is written in Markdown (see
418+[format a message](#format-a-message)).
348419
349420 ## Reactions
350421