Skip to content

markdown.md

Latest commit

 

History

History
107 lines (74 loc) · 2.61 KB

markdown.md

File metadata and controls

107 lines (74 loc) · 2.61 KB

Markdown

Links

Basics

You can create an inline link by wrapping link text in brackets [ ], and then wrapping the URL in parentheses ( ).

Link to part of the same document

You create one with [link text](#my-multi-word-header).

Comments in markdown

The recommended syntax is:

[//]: # (This may be the most platform independent comment)

There are other alternatives:

[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)

Or:

[//]: <> (This is also a comment.)

For maximum portability it is important to insert a blank line before and after this type of comments, because some Markdown parsers do not work correctly when definitions brush up against regular text.

Source: StackOverflow.

Tables

Basics

To add a table in Markdown, use the vertical line | to separate each column, and use three or more dashes --- to create each column's header. A vertical line should also be added at either end of the row.

| Month    | Savings |
| -------- | ------- |
| January  | $250    |
| February | $80     |
| March    | $420    |

Cell widths can vary, as shown below:

| Month | Savings |
| -------- | ------- |
| January | $250 |
| February | $80 |
| March | $420 |

The output will look exactly the same.

Text alignment

Align text in the columns to the left, right, or center by adding a colon : to the left, right, or on both side of the dashes --- within the header row.

| Item              | In Stock | Price |
| :---------------- | :------: | ----: |
| Python Hat        |   True   | 23.99 |
| SQL Hat           |   True   | 23.99 |
| Codecademy Tee    |  False   | 19.99 |
| Codecademy Hoodie |  False   | 42.99 |
  • :-- means the column is left aligned.
  • --: means the column is right aligned.
  • :-: means the column is center aligned.

Text formatting

Text can be formatted within tables. For example, links, emphasis, and inline code (words or phrases in backticks only, not code blocks) are all readily available for use within a table.

Several formatting options are not available within tables, including:

  • headings,
  • blockquotes,
  • horizontal rules,
  • images,
  • lists,
  • HTML tags.

Escaping Characters

Pipe characters | can be displayed in a table with the HTML character code &#124;.

Source: CodeCademy.