마크다운은 텍스트 기반의 경량 마크업 언어로, 가독성이 좋고 쉽게 작성할 수 있는 장점이 있습니다. Marked는 JavaScript로 작성된 마크다운 라이브러리로, 마크다운 파일을 HTML로 변환해주는 기능을 제공합니다. 이 가이드라인에서는 Marked를 사용하여 마크다운 파일을 만들고 관리하는 방법을 알아보겠습니다.
1. Marked 설치하기
마크다운 파일을 관리하기 위해 Marked를 사용하기 위해, 먼저 Marked를 설치해야 합니다. 다음의 명령어를 사용하여 Marked를 설치할 수 있습니다.
npm install marked
Marked는 Node.js에서 사용할 수 있는 패키지이기 때문에, Node.js가 설치되어 있어야 합니다.
2. Marked를 사용하여 마크다운 파일 변환하기
Marked를 설치한 후에는, 다음과 같이 간단히 마크다운 파일을 HTML로 변환할 수 있습니다.
const marked = require('marked');
const markdownText = `
# 제목
본문 내용입니다.
`;
const htmlText = marked(markdownText);
console.log(htmlText);
위의 예시에서는 marked를 사용하여 markdownText 변수에 있는 마크다운 텍스트를 HTML로 변환하고, 변환된 결과를 htmlText에 저장하고 출력합니다.
3. Marked 옵션 설정하기
Marked를 사용할 때는 다양한 옵션을 설정할 수 있습니다. 몇 가지 자주 사용되는 옵션들을 알아보겠습니다.
3.1. GFM(GitHub Flavored Markdown) 사용하기
GFM은 GitHub에서 제공하는 확장 마크다운 문법입니다. Marked에서는 GFM을 지원하며, 다음과 같이 gfm 옵션을 true로 설정하여 사용할 수 있습니다.
const marked = require('marked');
const markdownText = `
- [x] Task 1
- [ ] Task 2
`;
const htmlText = marked(markdownText, { gfm: true });
console.log(htmlText);
위의 예시에서는 markdownText 변수에 GFM 문법을 포함한 마크다운 텍스트를 작성하고, gfm 옵션을 true로 설정하여 변환한 결과를 출력합니다.
3.2. 헤더 ID 자동 생성하기
마크다운 파일에서 헤더에 ID를 자동으로 생성하는 기능이 필요할 수 있습니다. Marked에서는 headerIds 옵션을 설정하여 헤더 ID를 자동으로 생성할 수 있습니다.
const marked = require('marked');
const markdownText = `
# 제목
## 부제목
### 소제목
`;
const htmlText = marked(markdownText, { headerIds: true });
console.log(htmlText);
위의 예시에서는 markdownText 변수에 헤더를 작성하고, headerIds 옵션을 true로 설정하여 변환한 결과를 출력합니다.