paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-01 12:33:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

help: Fix misformatted MDX.

Browse Source 
Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg
2025-09-04 09:17:40 -07:00
committed by Anders Kaseorg
parent 1a05b2c10f
commit 2e805be1d8
5 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
starlight_help/src/content/docs/bots-overview.mdx
View File

@@ -36,11 +36,11 @@ Each bot has a **name**, **profile picture**, **email**, **bot type** and **API
The **bot type** determines what the bot can do.
Bot type | Permissions | Common uses
---|---|---
Generic | Like a normal user account | Automating tasks, bots that listen to all messages on a channel
Incoming webhook | Limited to only sending messages into Zulip | Automated notifications into Zulip
Outgoing webhook | Generic bot that also receives new messages via HTTP post requests | Third party integrations, most custom bots
| Bot type | Permissions | Common uses |
| ---------------- | ------------------------------------------------------------------ | --------------------------------------------------------------- |
| Generic | Like a normal user account | Automating tasks, bots that listen to all messages on a channel |
| Incoming webhook | Limited to only sending messages into Zulip | Automated notifications into Zulip |
| Outgoing webhook | Generic bot that also receives new messages via HTTP post requests | Third party integrations, most custom bots |
It's generally best to pick the most restricted bot type that is sufficient
to do the task at hand. Anyone with the bot's API key can do anything the

3
starlight_help/src/content/docs/format-a-quote.mdx
View File

@@ -38,13 +38,14 @@ import QuoteIcon from "~icons/zulip-icon/quote";
<StartComposing />
1. To create a multi-line quote, type `>` followed by a space and some text:
```
> a multi-line
quote on two lines
```
To create a multi-paragraph quote, use triple backticks and the word quote
(<code>```quote</code>) followed by some text and triple backticks at the end:
(` ```quote `) followed by some text and triple backticks at the end:
````
```quote

7
starlight_help/src/content/docs/latex.mdx
View File

@@ -20,11 +20,11 @@ import MathIcon from "~icons/zulip-icon/math";
Zulip's compose box has a smart **Math (LaTeX)** (<MathIcon />) button, which inserts contextually appropriate LaTeX
formatting:
* If no text is selected, the button inserts displayed LaTeX (<code>```math</code>) formatting.
* If no text is selected, the button inserts displayed LaTeX (` ```math `) formatting.
* If selected text is on one line, the button inserts inline LaTeX (`$$`)
formatting.
* If selected text is on multiple lines, the button inserts displayed LaTeX
(<code>```math</code>) formatting.
(` ```math `) formatting.
<Tabs>
<TabItem label="Via compose box button">
@@ -47,12 +47,13 @@ formatting:
<StartComposing />
1. To use inline LaTeX, use double dollar signs (`$$`) around the text:
```
$$O(n^2)$$
```
To use displayed LaTeX, use triple backticks and the word math
(<code>```math</code>) followed by some text and triple backticks at the end:
(` ```math `) followed by some text and triple backticks at the end:
````
```math

1
starlight_help/src/content/docs/schedule-a-reminder.mdx
View File

@@ -28,6 +28,7 @@ conversation at a later time.
<TabItem label="Desktop/Web">
<FlattenedSteps>
<MessageActions />
1. Click on the **ellipsis** (<MoreVerticalIcon />).
1. Click **Remind me about this**.
1. *(optional)* Add a note for yourself. You can use Zulip's standard [Markdown

2
starlight_help/src/content/docs/spoilers.mdx
View File

@@ -40,7 +40,7 @@ import SpoilerIcon from "~icons/zulip-icon/spoiler";
<StartComposing />
1. To create a spoiler section, use triple backticks and the word spoiler
(<code>```spoiler</code>) followed by an optional spoiler heading, some text, and triple
(` ```spoiler `) followed by an optional spoiler heading, some text, and triple
backticks at the end:
````