Develop

Github Markdown

hsleedevelop 2022. 5. 6. 20:55
반응형

- https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

- https://daringfireball.net/projects/markdown/syntax

Headings

# The largest heading
## The second largest heading
###### The smallest heading

Styling text

Bold ** ** or __ __ Command+B (Mac) or Ctrl+B (Windows/Linux) **This is bold text** This is bold text
Italic * * or _ _      Command+I (Mac) or Ctrl+I (Windows/Linux) *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 is extremely important
All bold and italic *** ***   ***All this text is important*** All this text is important

Quoting text

Text that is not a quote

> Text that is a quote

Quoting code

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:
```
git status
git add
git commit
```

[GitHub Pages](https://pages.github.com/).

Images

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

Lists

- George Washington
- John Adams
- Thomas Jefferson

1. James Madison
2. James Monroe
3. John Quincy Adams

Nested Lists

1. First list item
   - First nested list item
     - Second nested list item

 

100. First list item
     - First nested list item

100. First list item
     - First nested list item
       - Second nested list item

Task lists

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:

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

You can also use words, to fit your writing style more closely[^note].

[^1]: My reference.
[^2]: Every new line should be prefixed with 2 spaces.  
  This allows you to have a footnote with multiple lines.
[^note]:
    Named footnotes will still render with numbers instead of the text but allow easier identification and linking.  
    This footnote also has been made with a different syntax using 4 spaces for new lines.

The footnote will render like this:

Hiding content with comments

<!-- This content will not appear in the rendered Markdown -->

Ignoring Markdown formatting

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

 
 
 
반응형