Markdown is a lightweight and easy-to-use syntax for styling text in DigiQuatics.
What is Markdown?
Markdown is a way to style text on the web. You can control the display of your text; formatting words as bold or italic, and creating lists are just a few of the things you can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.
You can use Markdown in several places around DigiQuatics:
- Shift Reports
- Messaging
- Private Lesson Instructor Notes
- And more to come!
Syntax Guide
Here’s an overview of Markdown syntax that you can use for the above features:
Headers
Markdown:
Result:
Emphasis
Markdown:
Result:
Unordered Lists
Markdown: (be sure you put an extra line break before starting your bulleted list)
Result:
Ordered Lists
Markdown and result:
Images
Markdown:
Result:
Links
Markdown:
Result:
Blockquotes
Markdown:
Result:
For more information on advanced Markdown syntax check out this guide at GitHub.