Basic Writing and Formatting
Headings
To create a heading, add one to six #
symbols before your heading text. The number of #
you use will determine the size of the heading.
# The largest heading
## The second largest heading
###### The smallest heading
Styling text
You can indicate emphasis with bold, italic, or strikethrough text.
Style | Syntax | Keyboard shortcut | Example | Output |
---|---|---|---|---|
Bold | ** ** or __ __ | command/control + b | **This is bold text** | This is bold text |
Italic | * * or _ _ | command/control + i | *This text is italicized* | This text is italicized |
Strikethrough | ~~ ~~ | ~~This was mistaken text~~ | ||
Bold and nested italic | ** ** and _ _ | **This text is _extremely_ important** | This text is extremely important | |
All bold and italic | *** *** | ***All this text is important*** | All this text is important |
Quoting text
You can quote text with a >
.
In the words of Abraham Lincoln:
> Pardon my French
Quoting code
You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted.
Use `print("Hello World")` to print "Hello World" to the console.
To format code or text into its own distinct block, use triple backticks.
Some basic code : ``` int a = 5 print("Hello World") ```
Links
You can create an inline link by wrapping link text in brackets [ ]
, and then wrapping the URL in parentheses ( )
. You can also use the keyboard shortcut command + k
to create a link.
Click [here](https://www.google.com) for Google
Lists
You can make an unordered list by preceding one or more lines of text with -
or *
.
- George Washington
- John Adams
- Thomas Jefferson
To order your list, precede each line with a number.
1. James Madison
2. James Monroe
3. John Quincy Adams
Nested Lists
You can create a nested list by indenting one or more list items below another item.
To create a nested list using the web editor on Unifed, you can align your list visually. Type space characters in front of your nested list item, until the list marker character (-
or *
) lies directly below the first character of the text in the item above it.
1. First list item
- First nested list item
- Second nested list item
To create a nested list in the comment editor on Unifed, which doesn’t use a monospaced font, you can look at the list item immediately above the nested list and count the number of characters that appear before the content of the item. Then type that number of space characters in front of the nested list item.
In this example, you could add a nested list item under the list item 100. First list item
by indenting the nested list item a minimum of five spaces, since there are five characters (100.
) before First list item
.
100. First list item
- First nested list item
You can create multiple levels of nested lists using the same method. For example, because the first nested list item has seven spaces (␣␣␣␣␣-␣
) before the nested list content First nested list item
, you would need to indent the second nested list item by seven spaces.
100. First list item
- First nested list item
- Second nested list item
Task lists
If a task list item description begins with a parenthesis, you’ll need to escape it with \
:
- [ ] \(Optional) Graduate
Paragraphs
You can create a new paragraph by leaving a blank line between lines of text.
Ignoring Markdown formatting
You can tell the editor to ignore (or escape) Markdown formatting by using \
before the Markdown character.
Let's rename \*our-new-project\* to \*our-old-project\*.
LaTeX
You can write LaTeX equations by wrapping an equation in “$”.
$x^n + y^n = z^n$
You can also write multiline equations.
\[b_n=\frac{1}{\pi}\int\limits_{-\pi}^{\pi}f(x)\sin nx\,\mathrm{d}x\\ =\frac{1}{\pi}\int\limits_{-\pi}^{\pi}x^2\sin nx\,\mathrm{d}x\]