Basic writing and formatting syntax


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

The largest heading

The second largest heading

The smallest heading

Styling text

You can indicate emphasis with bold, italic, or strikethrough text.

Style Syntax Example Output
Bold ** ** **this is bold text** this is bold text
Italic * * or _ _ _this is italicized_ this is italicized
Bold and italic ** ** and _ _ **This text is _extremely_ important** This text is extremely important

Quoting text

You can quote text with a >.

In the words of Abraham Lincoln:  
> Pardon my French

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 `git status` to list all new or modified files that haven't yet been committed.

Use git status to list all new or modified files that haven't yet been committed.


To format code or text into its own distinct block, use triple backticks.


Some basic Git commands are:
```
function test() {
  console.log("notice the blank line before this function?");
}
```

Some basic Git commands are:

function test() {
  console.log("notice the blank line before this function?");
}

Syntax highlighting

You can add an optional language identifier to enable syntax highlighting in your fenced code block.

For example, to syntax highlight Ruby code:


```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

Rendered code block with Ruby syntax highlighting

We use highlight.js to perform language detection and syntax highlighting.


Links

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

This site was built using [Bootstrap 4](https://getbootstrap.com/docs/4.0/getting-started/introduction).

This site was built using Bootstrap 4.


Lists

You can make an unordered list by preceding one or more lines of text with - or *.


- George Washington
- John Adams
- Thomas Jefferson
  • 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
  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 GitHub or a text editor that uses a monospaced font, 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
  1. First list item
    • First nested list item
      • Second nested list item

Paragraphs and line breaks

You can create a new paragraph by leaving a blank line between lines of text.


Ignoring Markdown formatting

You can tell Markdown to ignore (or escape) Markdown formatting by using \ before the Markdown character.


Let's rename \*our-new-project\* to \*our-old-project\*.

Let's rename *our-new-project* to *our-old-project*.


Task list

- [x] Start a new poject
- [ ] work on it
- [ ] Finish project
  • Start a new poject
  • work on it
  • Finish project

Links for further reading



TITLE: Basic writing and formatting syntax
DATE: 2017-11-13
AUTHOR: jRu
TAGS:
html markdown syntax