ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • [Git] README 작성을 위한 MarkDown 문법
    기타 2024. 1. 3. 21:22

    MarkDown 문법 왜 궁금했을까❓

    - 1월 1일부터 Github, Blog 등을 운영하여 IT 역량들을 정리하려고 했다.
    - 다른 Github들을 참고해보니 README를 사용하여 프로젝트에 대한 설명을 하는데 README 파일은 확장자 md를 가진 MarkDown 문법을 사용하고 있었다.
    - MarkDown 문법에 대해 무지하여 공부하고 README를 작성해보려고 한다.

     

     

    MarkDown 문법 정리

    제목 (Header)

    <h1>부터 <h6>까지 제목을 표현할 수 있다.

     

    강조 (Emphasis)

    기울기 - *(asterisks), _(underscore)
    두껍게 - **(asterisks), __(underscore)
    취소선 - ~~(tilde)

     

    목록 (List)

    순서가 필요한 목록 - 1, 2, 3, 4
    순서가 필요하지 않은 목록 - -(hyphen)

     

    링크 (Link)

    [원하는 텍스트 입력](Target URL)
    [원하는 텍스트 입력](Target URL "텍스트에 Cursor 올리면 표시될 텍스트 입력")
    <Target URL>
    [원하는 텍스트 입력][참조 링크] - 문서 안에서 이동 가능

     

    이미지 (Image)

    ! [대체 텍스트 입력](이미지 주소 "텍스트에 Cursor 올리면 표시될 텍스트 입력")
    [대체 텍스트 입력][참조 링크] - 문서 안에서 참조

     

    코드(Code) 강조

    인라인(inline) 코드 강조

    `(Grave)

    블록(block) 코드 강조

    ```코드 종류(html, css, javasciprt )

     

    표 (Table)

    기본
    |제목 셀1|제목 셀2|제목 셀3|제목 셀4|
    |---|---|---|---|
    |내용 1|내용 2|내용 3|내용 4|
    |내용 5|내용 6|내용 7|내용 8|
    |내용 9|내용 10|내용 11|내용 12|

    정렬
    |기본값|왼쪽 정렬|가운데 정렬|오른쪽 정렬|
    |---|:---|:---:|---:|
    |내용 1|내용 2|내용 3|내용 4|
    |내용 5|내용 6|내용 7|내용 8|
    |내용 9|내용 10|내용 11|내용 12|

     

    인용문 (BlockQuote)

    >를 사용하며 중첩 가능

     

    수평선 (Horizontal Rule)

    --- (Hyphens)
    ***(Asterisks)
    ___(Underscores)

     

    줄바꿈 (Line break)

    띄어쓰기 2번
    <br> 태그 사용

     

    README 작성 결과물

     

    GitHub - chanhong9764/shareyourtrip: 실시간 여행 일정 관리 플랫폼

    실시간 여행 일정 관리 플랫폼. Contribute to chanhong9764/shareyourtrip development by creating an account on GitHub.

    github.com

     

Designed by Tistory.