초보자를 위한 Markdown - 더 나은 Readme 만들기

마크다운이란?



Markdown은 가장 널리 사용되는 마크업 언어 중 하나입니다. 2004년에 John Gruber에서 개발한 이 도구는 일반 텍스트 문서에 서식(및 pizazz)을 추가하는 간단하고 가벼운 방법입니다. 그루버의 말:

Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).



우리 중 많은 사람들이 변경 사항을 즉시 볼 수 있는 Microsoft Word와 같은 서식 있는 텍스트 편집기에 익숙하지만 Markdown은 고유한 일반 텍스트 구문을 사용하여 텍스트 표시 방식을 변경합니다. 이 가이드는 일반적으로 사용되는 Markdown 구문을 살펴보므로 더 나은 GitHub README를 만들 수 있습니다!

모든 텍스트 편집기 응용 프로그램을 사용하여 Markdown을 추가할 수 있습니다. Markdown 응용 프로그램도 있으며 그 중 일부는 문서를 실시간으로 미리 볼 수 있습니다. 우리의 목적을 위해 Dillinger 을 따라하면 변경 사항을 즉시 확인할 수 있습니다.


제목



H1에서 H6까지 6개의 헤더를 사용할 수 있습니다.

Markdown 구문은 다음과 같습니다.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6


제목 1



제목 2



제목 3



제목 4




제목 5


제목 6



텍스트에 강조 추가



다음은 텍스트를 볼드체, 이탤릭체 및 밑줄체로 만드는 Markdown 구문입니다. 또한 취소선 방법을 사용하여 텍스트에 취소선을 그거나 '줄을 그을 수' 있습니다.

**bold**
_italic_
<u>underlined</u>
~~strike through~~


보너스: 아래 첨자 및 위 첨자



때때로 우리는 화학 표기법 H20 또는 지수 x2와 같은 것에 위첨자를 사용하기를 원할 수 있습니다. Markdown을 사용하면 간단합니다.

H<sub>2</sub>0
x<sup>2</sup>


위 첨자의 경우 아래 첨자를 만들려는 요소를 'sub' 태그로 둘러쌉니다. 아래 첨자의 경우 요소를 'sup' 태그로 묶습니다.


구문 및 코드 블록 강조



백틱 하나를 사용하면 단어나 코드 조각이 됩니다highlight. 아래 예에서 확인할 수 있습니다.

이 문장에서 hello라는 단어가 강조 표시됩니다.

세 개의 백틱을 사용하면 코드 블록이 생성됩니다. 백틱 바로 뒤에 언어 식별자를 추가하면 더 다채롭고 읽기 쉬운 코드가 됩니다. 다음은 JavaScript를 사용한 예입니다.

const makeAVariable = 'Hello'

// This will show different colors 
console.log(makeAVariable)



인용 부호



따옴표를 표시하려면 보다 큼 기호를 사용하십시오. 인용문은 다른 사람의 작업을 참조할 때 매우 유용합니다. 신용이 필요한 곳에서 신용을 얻는 것이 중요합니다.

"Make sure to save your code!" - Megan




기울기



순서가 있는 목록을 만들려면 1부터 시작하여 위로 세십시오.
  • 항목 1
  • 항목 2
  • 항목 3

  • 목록에 하위 항목을 만들고 글머리 기호를 포함할 수도 있습니다.
  • 항목 1
  • 하위 항목 1
  • 하위 항목 2

  • 항목 2
  • 하위 항목 3

  • 항목 3

  • 정렬되지 않은 목록은 각 항목 앞에 빼기 기호를 사용하여 생성됩니다. 아래를 참조하십시오.

    쇼핑리스트:
  • 시리얼
  • 달걀
  • 치즈



  • 이미지 및 이모티콘



    이미지를 추가하려면 다음과 같이 느낌표 다음에 대체 텍스트가 포함된 대괄호를 사용하고 HTML 링크를 괄호 안에 넣습니다. ![alt text](url)


    Markdown에서 이모지를 사용할 수도 있습니다. 인식된 이모지의 전체 목록이 있습니다here.

    😍👍🐰


    연결



    링크를 만들려면 링크 텍스트를 대괄호로 묶은 다음 가리키고 싶은 URL을 괄호로 묶습니다. 구문은 다음과 같습니다. [](url)
    아래의 훌륭한 링크를 확인하십시오!
    My GitHub



    이것은 Markdown을 사용하여 README 파일을 더 아름답게 만드는 빠른 가이드였습니다. 아래 의견에 새 README를 보여주세요!

    좋은 웹페이지 즐겨찾기