• 마크다운(Markdown)


마크다운(markdown)은 일반 텍스트 기반의 경량 마크업 언어이며, 일반 마크업 언어에 비해 문법이 쉽고 간단하다. README 파일이나 온라인 게시물(belog) 등에 많이 사용된다. 'md' 확장자도 'txt' 확장자와 동일하게 텍스트 문서를 적기 위한 파일을 나타낸다. '.md' 확장자로 만든 파일을 '마크다운 문서'라고 부른다.
ref) 마크다운(위키피디아)

  • 마크다운 작성 방법


1. Header 작성


큰제목과 소제목 작성

큰제목은 작성 후에 다음 줄에 '=='를, 소제목은 '--'를 입력하면 제목과 소제목으로 인식되어 큰 글자가 된다. 하지만 '1.'과 같은 순서있는 번호를 사용시에는 번호만 제외된 채 커진다.

제목

==

소제목

--

글머리 작성

글머리는 글자 크기를 단계별로 1~6까지 지원하고 있으며, '#'을 많이 입력할수록 글자 크기가 작아진다.

H1 -> # H1

H2 -> ## H2

H3 -> ### H3

H4 -> #### H4

H5 -> ##### H5
H6 -> ###### H6

2. Block 만들기


block은 '>'를 입력하여 만들 수 있고, block안에 block을 추가하는 것도 가능하다. enter를 두번 입력하면 block을 구분할 수 있다.

1번 block
> 2번 block
>> 3번 block

1번 block

2번 block

3번 block

3. 목록


목록의 순서

'1.', '2.', '3.'으로 순서가 있는 목록을 만들 수 있으며, 이 숫자 순서를 바꿔서 작성해도 내림차순으로 바뀌어 출력된다. 따라서 순서에 상관없는 목록을 만들고 싶다면, '*', '+', '-'를 사용하여 목록을 만들며 2칸의 공백으로 들여쓰기를 한다.

1. 1번
3. 3번
2. 2번
  1. 1번
  2. 3번
  3. 2번
* 1번
  + 2번
    - 3번
  • 1번
    • 2번
      • 3번

4. 그외 문법


수평선

수평선은 '---', '***'중 하나로 사용한다.

---
***


링크

링크는 web 주소를 그래도 적어도 되지만 기본 사용 문법은 [title][web주소]로 사용하며, 2가지 사용방법에 따라 출력되는 화면도 차이가 있다.

goggle : https://www.google.co.kr/
[goggle](https://www.google.co.kr/)

goggle : https://www.google.co.kr/
goggle

  • 마무리


마크다운 문법을 알지 못해도 개발자가 될 수는 있을 것이다. 하지만 협업 프로젝트나 남들에게 자신이 개발한 프로그램을 설명하기 위한다면, 마크다운 문서는 개발자로서 알아야할 기본 중 하나라고 생각한다.

  • 참고 자료


1. Visual Studio Code


비주얼 스튜디오 코드는 메모장과 같은 텍스트 에디터라고 생각하면 된다. 메모장으로도 코드를 작성하고, 수정하는 것이 기능적으로 문제는 없겠지만 프로그램 전체의 코드를 메모장으로 만드는건 굉장히 고된 일이 될 것이다. 비주얼 스튜디오 코드는 개발자에게 여러 기능을 제공해 주는 무료 에디터이다. 문법 강조, 코드 자동 완성, 버그 추적과 git 연동 등의 코드 작성에 유용한 기능이 많다. 저는 코드나 마크다운 문서 작성에서 VSCode를 주로 사용하고 있다.

2. 설치 및 한글 설정하기


설치 방법

1) 구글에 'Visual Studio Code'를 검색한 후, https://code.visualstudio.com/ 링크로 접속한다.
2) 자신의 OS에 맞는 설치 파일을 내려받고 설치를 시작한다.
3) 기본 설정을 유지한 채, 끝까지 [다음][설치] 버튼을 클릭하면 설치가 완료돤다.

한글 설정

1) 실행 화면을 보면 왼쪽에 6개의 아이콘 중 마지막 '확장'을 선택한다.
2) 검색창에 'korean'이라고 검색한 후, 'Korean Language Pack for Visual Studio Code'를 선택해 설치한다.
3) 설치 완료 후 오른쪽 아래에 알림이 뜨면 'Restart Now' 버튼을 눌러 비주얼 스튜디오를 재시작한다.

profile
NLP, AI, LLM, MLops

0개의 댓글

Powered by GraphCDN, the GraphQL CDN