Skip to content

Commit 154c4ff

Browse files
[Documentation:Markdown] Enhanced Markdown Documentation for Additional Features (#573)
Fixes Submitty/Submitty#10072 , where the Markdown editor in Submitty lacked documentation for certain features, specifically tables. I have added comprehensive instructions on how to create tables in Markdown to enhance the documentation. --------- Co-authored-by: Barb Cutler <[email protected]>
1 parent b13fad4 commit 154c4ff

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

_docs/student/communication/markdown.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@ title: Writing Markdown
77
## Formatting using Markdown
88

99
Markdown has become a common standard for formatting online text.
10-
Submitty allows simple formatting using markdown in several
11-
Click on the markdown symbol to enable formatting of your post
12-
using markdown.
10+
Submitty allows simple formatting using markdown in
11+
[Discussion Forum](/student/communication/forum) posts
12+
(and also on several other Submitty webpages).
13+
14+
To begin, click the markdown symbol to enable formatting of your post using markdown.
15+
Then use the standard markdown syntax show below:
1316

1417
* **Headings**
1518
Adding a number of `#` and a space before text will make it a heading:
@@ -97,4 +100,16 @@ using markdown.
97100
3. Item 3
98101
```
99102
103+
* **Table**
104+
105+
To add a table, use three or more hyphens `(---)` to create each column’s header, and use pipes `(|)` to separate each column. For compatibility, you should also add a pipe on either end of the row.
106+
107+
```
108+
| Syntax | Description |
109+
| ----------- | ----------- |
110+
| Header | Title |
111+
| Paragraph | Text |
112+
113+
```
100114
115+
For more information, see also: [Markdown Guide](https://www.markdownguide.org/)

0 commit comments

Comments
 (0)