1.3 KiB
SCAR-iT Style Guidelines
Markdown Style Guide Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Here's a simple guide:
-
Headers: Use # for headers. The number of # indicates the level of the header. For example, # Header 1, ## Header 2, ### Header 3.
-
Emphasis: Use * for emphasis. For example, italic or bold.
-
Lists: Use - for unordered lists and numbers for ordered lists. For example:
-
Item 1
-
Item 2
or
- Item 1
- Item 2
-
Links: Use link text to create a hyperlink. For example, Bing.
-
Code: Use backticks (`) to denote code. Use single backticks for inline code and triple backticks for blocks of code.
-
{InLine Code} -
Blocks of Code
var foo = bar:
- Tables: Use | to create tables. For example:
| Column 1 | Column 2 |
|---|---|
| Cell 1 | Cell 2 |
- Blockquotes: Use > for blockquotes. For example,
This is a quote.
- Horizontal Rule: Use --- or *** to create a horizontal rule. Example:
- Strikethrough: Use ~~ for strikethrough. For example,
strikethrough.
Remember, the goal of using Markdown is to make documents more readable. Keep it simple and consistent.
