Rich Text
Markdown is a simplified markup language designed to be easy to use for people who don’t code. To add content using markdown, select 'markdown' from the drop-down box in the top-right of the content page you’re editing. HTML cannot be used in Markdown mode.
Simple guide to Rich Text
Common formatting options
Bold
All text between the * will be bold. Don’t put a space between the * and the text
*The sun was *shining on the sea*
Output: The sun was shining on the sea
Italic
All text between the _ will be italics. Don’t put a space between the _ and the text.
_Shining with _all its might_
Output: Shining with all its might
List - Circle
Make sure you put a space after the * on each line.
* Now this was very odd
* because it was
* the middle of the night
Output:
- Now this was very odd
- because it was
- the middle of the night
List - Number
Make sure you put a space after the . on each line. If you want an ordered sub-list, at any point put three spaces before the number.
1. Now this was very odd
2. because it was
3. the middle of the night
1. it was dark
2. no one was home
Output:
- Now this was very odd
- because it was
- the middle of the night
- it was dark
- no one was home
# - Large heading
Header are created using the hashtag symbol, a space and then the heading. You can use up to four hastags in a row for different level headings. See below under Headers for more information.
# The Moon
Output: The Moon
Link
The url is the link the user will be redirected to upon clicking, while the text wrapped in the brackets becomes the hyperlink text.
https://hole.example.com[Alice]
Output: Alice
Headers
To type out a header, add a # symbol at the beginning of the line. The number of # you use, up to 4 total, sets the type of heading that’s used.
# = H1
## = H2
### = H3
#### = H4
Emphasis
You can bold or italicize text by wrapping the text in asterisks and/or underscores.
You can **bold text** using twin asterisk's (**) on either side of the text you want to emphasize.
You can use _italics_ by using an underline (_) on either side of the text you want to emphasize.
You can also combine the two to create text that's **both bold and _italicized_**.
Line Breaks
Line breaks can be added by starting a new paragraph with a line gap in between the first paragraph and the second.
Lists
You can create both ordered and unordered lists, and combinations of the two as well. Some examples include:
* This is
* an unordered
* list
1. This is the first entry in an ordered list
2. second entry
1. ordered sub-list 1
2. ordered sub-list 2
3. third entry
4. fourth entry
* the fourth entry has an unordered sub-list
* second entry in the unordered sub-list
5. fifth entry
Links
You can create in-links using the following syntax:
[The text you want inside the link](https://www.theurl.com.au)
It’ll come out something like this:
Click this [link to search](https://www.google.com.au) for your favourite courses
Images
You can reference images stored in your onCourse documents by using its reference URL like so:
![alt text](https://ish-oncourse-sttrianians.s3.amazonaws.com/3073ca8f-9a6a-4269-b9d4-209afbe46bfc?versionId=qRoc1Vwc937UdaGLLxz6aqJ250_bc.Im "Title Text")
Whatever you put in 'Title Text' will appear when hovering the mouse over the image and is useful as a caption.
Code blocks
You can highlight portions of text to preserve things like code formatting by flanking the text using the ` symbol. You can also create code blocks this way, see the example below:
You can highlight `certain words` or a `call to action` like this.
<!DOCTYPE html>
<html>
<body>
<p>This is how you can present code using markdown.</p>
<p>This example uses html, but it can be anything you like.</p>
</body>
</html>
Videos
You can insert videos using pure Markdown, however it’s far simpler (and better for users as well) if you simply embed the html code into the page. Video services like YouTube have an easy 'Embed' button that gives you the code you need to copy and paste into the content field of the page you’re editing.
Block Quotes
You can add Block Quotes to your text by using a > symbol at the beginning of the line, like so:
> This is a block quote.
> This is a part of the same block quote.
Updated 5 months ago