diff --git a/help/format-your-message-using-markdown.md b/help/format-your-message-using-markdown.md index 32133f038f..04f1d7b249 100644 --- a/help/format-your-message-using-markdown.md +++ b/help/format-your-message-using-markdown.md @@ -16,7 +16,7 @@ whenever you need a reminder of the formatting syntax below. * [Text emphasis](#text-emphasis) * [Bulleted lists](#bulleted-lists) * [Numbered lists](#numbered-lists) -* [Links and images](#links) +* [Links](#links) * [Code blocks](#code) * [LaTeX](#latex) * [Quotes](#quotes) @@ -42,32 +42,14 @@ whenever you need a reminder of the formatting syntax below. ## Links -Zulip auto-linkifies URLs and [valid stream (and topic) names][link-to-conversation]. -You can also add a [custom linkifier](/help/add-a-custom-linkifier) to link -patterns like `#1234` to your ticketing system. +{!links-intro.md!} -[link-to-conversation]: /help/link-to-a-message-or-conversation +{!links-examples.md!} -``` -Auto-detected URL: zulip.com -Named link: [Zulip homepage](zulip.com) -Stream: #**stream name** -Topic: #**stream name>topic name** -Custom linkifier: #1234 (links to ticket 1234 in your ticketing system) -``` - -![Markdown links](/static/images/help/markdown-links.png) - -## Images - -See [Share and upload files](/help/share-and-upload-files) to learn more -about dropping, pasting, and attaching images. - -``` -[A whale of a good time](https://your.zulip.domain/user_uploads/1/46/IPvysqXEtiTG1ZdNBrwAZODi/whale-time.png) -``` - -![Markdown image](/static/images/help/markdown-image.png) +!!! tip "" + You can also use a button or a keyboard shortcut (Ctrl + + Shift + L) to insert a link. + [Learn more](/help/insert-a-link). ## Code diff --git a/help/include/links-examples.md b/help/include/links-examples.md new file mode 100644 index 0000000000..132b08b958 --- /dev/null +++ b/help/include/links-examples.md @@ -0,0 +1,13 @@ +### What you type + +``` +Named link: [Zulip homepage](zulip.com) +A URL (links automatically): zulip.com +Stream link: #**stream name** +Stream and topic link: #**stream name>topic name** +Custom linkifier: For example, #2468 can automatically link to an issue in your tracker. +``` + +### What it looks like + +![Markdown links](/static/images/help/markdown-links.png) diff --git a/help/include/links-intro.md b/help/include/links-intro.md new file mode 100644 index 0000000000..fdd346c7dd --- /dev/null +++ b/help/include/links-intro.md @@ -0,0 +1,8 @@ +In Zulip, you can insert a named link using Markdown formatting. In addition, Zulip +automatically creates links for you when you enter: + +- A URL +- An appropriately formatted stream name, or a stream name followed by a topic + (see also [Link to a message or + conversation](/help/link-to-a-message-or-conversation)) +- Text that matches a [custom linkifier](/help/add-a-custom-linkifier) set up by your organization diff --git a/help/include/sidebar_index.md b/help/include/sidebar_index.md index d54698f776..c4669f8fee 100644 --- a/help/include/sidebar_index.md +++ b/help/include/sidebar_index.md @@ -60,6 +60,7 @@ * [Mention a user or group](/help/mention-a-user-or-group) * [Quote and reply](/help/quote-and-reply) * [Emoji and emoticons](/help/emoji-and-emoticons) +* [Insert a link](/help/insert-a-link) * [Share and upload files](/help/share-and-upload-files) * [Add GIFs in your message](/help/animated-gifs-from-giphy) * [Text emphasis](/help/text-emphasis) diff --git a/help/insert-a-link.md b/help/insert-a-link.md new file mode 100644 index 0000000000..8911235a55 --- /dev/null +++ b/help/insert-a-link.md @@ -0,0 +1,50 @@ +# Insert a link + +{!links-intro.md!} + +## Examples + +{!links-examples.md!} + +## Insert a link + +{start_tabs} + +{tab|via-markdown} + +{!start-composing.md!} + +1. Wrap the link text in square brackets followed by the URL + wrapped in parentheses to create a named link: + `[link text](URL)` + +!!! keyboard_tip "" + + You can also use Ctrl + Shift + L + to insert link formatting. + +{tab|via-compose-box-buttons} + +{!start-composing.md!} + +1. Select the text you want to linkify. + +1. Click the **link** () icon at the + bottom of the compose box. + +1. Replace `url` with a valid URL. + +!!! keyboard_tip "" + + You can also use Ctrl + Shift + L + to insert link formatting. + +{end_tabs} + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Preview messages before sending](/help/preview-your-message-before-sending) +* [Resize the compose box](/help/resize-the-compose-box) +* [Animated GIFs](/help/animated-gifs-from-giphy) +* [Video calls](/help/start-a-call) diff --git a/static/images/help/markdown-image.png b/static/images/help/markdown-image.png deleted file mode 100644 index 36983a16fb..0000000000 Binary files a/static/images/help/markdown-image.png and /dev/null differ diff --git a/static/images/help/markdown-links.png b/static/images/help/markdown-links.png index ef567130ba..9ea8fee467 100644 Binary files a/static/images/help/markdown-links.png and b/static/images/help/markdown-links.png differ