Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation:Markdown] Enhanced Markdown Documentation for Additional Features #573

Merged
merged 3 commits into from
Jun 5, 2024
Merged

[Documentation:Markdown] Enhanced Markdown Documentation for Additional Features #573

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae6fb89
Table added in markdown file
NareshBiradar1 Dec 19, 2023
811b5f7
Merge branch 'main' into main
bmcutler Jun 4, 2024
9569437
small revisions
bmcutler Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions _docs/student/communication/markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@ title: Writing Markdown
## Formatting using Markdown

Markdown has become a common standard for formatting online text.
Submitty allows simple formatting using markdown in several
Click on the markdown symbol to enable formatting of your post
using markdown.
Submitty allows simple formatting using markdown in
[Discussion Forum](/student/communication/forum) posts
(and also on several other Submitty webpages).

To begin, click the markdown symbol to enable formatting of your post using markdown.
Then use the standard markdown syntax show below:

* **Headings**
Adding a number of `#` and a space before text will make it a heading:
Expand Down Expand Up @@ -97,4 +100,16 @@ using markdown.
3. Item 3
```

* **Table**

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.

```
bmcutler marked this conversation as resolved.
Show resolved Hide resolved
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

bmcutler marked this conversation as resolved.
Show resolved Hide resolved
```
bmcutler marked this conversation as resolved.
Show resolved Hide resolved

For more information, see also: [Markdown Guide](https://www.markdownguide.org/)
Loading