From 5f8d5eeb22bbc57558d243000d1f48cec9ba60f0 Mon Sep 17 00:00:00 2001 From: David Rosa Date: Tue, 14 Mar 2023 21:06:04 -0600 Subject: [PATCH] help: Add a dedicated page on how to format tables. --- help/format-your-message-using-markdown.md | 13 ++----------- help/include/sidebar_index.md | 1 + help/include/tables-examples.md | 19 +++++++++++++++++++ help/include/tables-intro.md | 1 + help/tables.md | 13 +++++++++++++ 5 files changed, 36 insertions(+), 11 deletions(-) create mode 100644 help/include/tables-examples.md create mode 100644 help/include/tables-intro.md create mode 100644 help/tables.md diff --git a/help/format-your-message-using-markdown.md b/help/format-your-message-using-markdown.md index fceb600d19..07ef0c4849 100644 --- a/help/format-your-message-using-markdown.md +++ b/help/format-your-message-using-markdown.md @@ -106,18 +106,9 @@ whenever you need a reminder of the formatting syntax below. ## Tables -The initial pipes (`|`) are optional if every entry in the first column is non-empty. -The header separators (`---`) must be at least three dashes long. +{!tables-intro.md!} -``` -|| yes | no | maybe -|---|---|:---:|------: -| A | left-aligned | centered | right-aligned -| B | extra spaces | are | ok -| C | **bold** *italic* ~~strikethrough~~ :smile: || -``` - -![Markdown table](/static/images/help/markdown-table.png) +{!tables-examples.md!} ## To-do lists diff --git a/help/include/sidebar_index.md b/help/include/sidebar_index.md index 7d9b2ec616..734abadeff 100644 --- a/help/include/sidebar_index.md +++ b/help/include/sidebar_index.md @@ -66,6 +66,7 @@ * [Add GIFs in your message](/help/animated-gifs-from-giphy) * [Text emphasis](/help/text-emphasis) * [Bulleted and numbered lists](/help/bulleted-and-numbered-lists) +* [Tables](/help/tables) * [Code blocks](/help/code-blocks) * [LaTeX](/help/latex) * [Spoilers](/help/spoilers) diff --git a/help/include/tables-examples.md b/help/include/tables-examples.md new file mode 100644 index 0000000000..363181bad3 --- /dev/null +++ b/help/include/tables-examples.md @@ -0,0 +1,19 @@ +### What you type + +``` +|| yes | no | maybe +|---|---|:---:|------: +| A | left-aligned | centered | right-aligned +| B | extra spaces | are | ok +| C | **bold** *italic* ~~strikethrough~~ :smile: || +``` + +!!! tip "" + + The initial pipes (`|`) are optional if every entry in the first column is + non-empty. + The header separators (`---`) must be at least three dashes long. + +### What it looks like + +![Markdown table](/static/images/help/markdown-table.png) diff --git a/help/include/tables-intro.md b/help/include/tables-intro.md new file mode 100644 index 0000000000..6a620145b5 --- /dev/null +++ b/help/include/tables-intro.md @@ -0,0 +1 @@ +Zulip supports Markdown formatting for tables. diff --git a/help/tables.md b/help/tables.md new file mode 100644 index 0000000000..791fedd0d7 --- /dev/null +++ b/help/tables.md @@ -0,0 +1,13 @@ +# Tables + +{!tables-intro.md!} + +## Examples + +{!tables-examples.md!} + +## 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)