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.

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

Conversation

NareshBiradar1
Copy link
Contributor

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.

Copy link
Contributor

@PythonCoderAS PythonCoderAS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few syntax corrections.

| Paragraph | Text |

```
For more Information , [Click here](https://www.markdownguide.org/extended-syntax/#tables)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For more Information , [Click here](https://www.markdownguide.org/extended-syntax/#tables)
For more information, [click here](https://www.markdownguide.org/extended-syntax/#tables)


```
For more Information , [Click here](https://www.markdownguide.org/extended-syntax/#tables)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
There are also several tools online that can aid with creating a markdown table, such as [this tool](https://tableconvert.com/markdown-generator).

_docs/student/communication/markdown.md Show resolved Hide resolved
_docs/student/communication/markdown.md Outdated Show resolved Hide resolved

```
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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

_docs/student/communication/markdown.md Show resolved Hide resolved
_docs/student/communication/markdown.md Show resolved Hide resolved
@bmcutler bmcutler merged commit 154c4ff into Submitty:main Jun 5, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Further document Markdown
3 participants