README hub

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, strikethrough, subscript, or superscript text in comment fields and .md files.

Style	Syntax	Example	Output
Bold	` ` or`__ __`	`This is bold text`	This is bold text
Italic	`* *` or`_ _`	`This text is italicized`	This text is italicized
Strikethrough	`~~ ~~`	`~~This was mistaken text~~`	~~This was mistaken text~~
Bold and nested italic	` ` and`_ _`	`This text is _extremely_ important`	This text isextremelyimportant
All bold and italic	`* *`	`*All this text is important*`	*All this text is important*
Subscript	`<sub> </sub>`	`<sub>This is a subscript text</sub>`	_{This is a subscript text}
Superscript	`<sup> </sup>`	`<sup>This is a superscript text</sup>`

Quoting text

You can quote text with a>.

Text that is not a quote> Text that is a quote

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.

Some basic Git commands are:```git statusgit addgit commit```

Supported color models

In issues, pull requests, and discussions, you can call out colors within a sentence by using backticks. A supported color model within backticks will display a visualization of the color.

The background color should be `#ffffff` for light mode and `#0d1117` for dark mode.

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 [GitHub Pages](https://pages.github.com/).

Section links

You can link directly to a section in a rendered file by hovering over the section heading to expose the link.

Relative links

You can define relative links and image paths in your rendered files to help readers navigate to other files in your repository.

A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this:

[Contribution guidelines for this project](docs/CONTRIBUTING.md)

GitHub will automatically transform your relative link or image path based on whatever branch you're currently on, so that the link or path always works. The path of the link will be relative to the current file. Links starting with/ will be relative to the repository root. You can use all relative link operands, such as ./ and../.

Images

You can display an image by adding! and wrapping the alt text in [ ]. Then wrap the link for the image in parentheses( ) .

![This is an image](https://myoctocat.com/assets/images/base-octocat.svg)

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. 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

Task lists

To create a task list, preface list items with a hyphen and space followed by [ ].To mark a task as complete, use[x].

- [x] Convert text into issues #739 
- [ ] Keep issue state and checkboxes in sync #740

If a task list item description begins with a parenthesis, you'll need to escape it with\:

- [ ] \(Optional) Open a followup issue

Using Emoji

You can add emoji to your writing by typing:EMOJICODE:, a colon followed by the name of the emoji.

:+1: This PR looks great - it's ready to merge! :+1:
👍 This PR looks great - it's ready to merge! 👍

For a full list of available emoji and codes, seeHere.

Paragraphs

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

Footnotes

You can add footnotes to your content by using this bracket syntax:

Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
[^1]: My reference.
[^2]: To add line breaks within a footnote, prefix new lines with 2 spaces. This is a second line.

Ignoring Markdown formatting

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

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

Creating a table

You can create tables with pipes|and hyphens-. Hyphens are used to create each column's header, while pipes separate each column. You must include a blank line before your table in order for it to correctly render.

| Fname | Lname |
| ----- | ----- |
| Mohak | Moore |
| Mitra | Myers |
| Miina | Mills |

Formatting content within your table

You can use formatting such as links, inline code blocks, and text styling within your table:

| Command | Description |
| --- | --- |
| `git status` | List all *new or modified* files |
| `git diff` | Show file differences that **haven't been** staged |

You can align text to the left, right, or center of a column by including colons :to the left, right, or on both sides of the hyphens within the header row.

| Left-aligned | Center-aligned | Right-aligned |
| :--- | :---: | ---: |
| git status | git status | git status |
| git diff | git diff | git diff |

To include a pipe| as content within your cell, use a\ before the pipe:

| Name | Character |
| --- | --- |
| Backtick | ` |
| Pipe | \| |

Creating a collapsed section

You can temporarily obscure sections of your Markdown by creating a collapsed section that the reader can choose to expand. For example, when you want to include technical details in an issue comment that may not be relevant or interesting to every reader, you can put those details in a collapsed section.
Any Markdown within the<details> block will be collapsed until the reader clicks ▶ to expand the details. Within the <details>block, use the<summary>tag to let readers know what is inside. The label appears to the right of ▶.

<details>
<summary>Tips for collapsed sections</summary>

### You can add a header
You can add text within a collapsed section.
You can add an image or a code block, too.
```ruby
   puts 'Hello World'
```
</details>

Create code blocks

You can create fenced code blocks by placing triple backticks```before and after the code block. We recommend placing a blank line before and after code blocks to make the raw formatting easier to read.

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

You can add an optional language identifier to enable syntax highlighting in your fenced code block.
Syntax highlighting changes the color and style of source code to make it easier to read.
For example, to syntax highlight Ruby code:

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

READMEhub