Marked를 사용하여 마크다운 문서를 개발 문서로 활용하는 방법

마크다운은 텍스트 기반의 경량 마크업 언어로, 개발 문서 작성에 매우 편리하게 사용될 수 있습니다. Marked는 Node.js 기반의 마크다운 라이브러리로, 마크다운 문서를 HTML로 변환해주는 기능을 제공합니다. 이번 글에서는 Marked를 사용하여 마크다운 문서를 개발 문서로 활용하는 방법을 알아보겠습니다.

1. Marked 설치

Marked를 사용하기 위해 먼저 Node.js 환경에서 Marked를 설치해야 합니다. 아래의 명령을 터미널에 입력하여 Marked를 설치할 수 있습니다.

npm install marked

2. Marked를 활용한 마크다운 변환

Marked를 설치했다면, 이제 마크다운 문서를 HTML로 변환할 수 있습니다. 아래의 예제 코드를 참고하여 마크다운 파일을 HTML로 변환하는 방법을 알아보세요.

const marked = require('marked');
const fs = require('fs');

// 마크다운 파일 읽기
const markdown = fs.readFileSync('example.md', 'utf-8');

// 마크다운을 HTML로 변환
const html = marked(markdown);

// 변환된 HTML 출력
console.log(html);

위의 예제 코드에서는 먼저 marked 모듈을 불러온 뒤, fs 모듈을 사용하여 마크다운 파일을 읽어옵니다. 그리고 marked 함수를 사용하여 마크다운을 HTML로 변환하고, 변환된 HTML을 출력합니다.

3. 변환된 HTML 활용

마크다운을 HTML로 변환한 후, 이를 웹페이지에 삽입하거나 다른 방식으로 활용할 수 있습니다. 변환된 HTML을 웹페이지에 삽입하기 위해서는 해당 HTML을 <div> 또는 <iframe> 등의 HTML 요소에 삽입하면 됩니다. 또는 변환된 HTML을 파일로 저장하여 웹서버에서 정적 파일로 제공할 수도 있습니다.

4. 추가적인 옵션 사용

Marked는 다양한 옵션을 제공하여 마크다운 변환 과정을 커스터마이징할 수 있습니다. 예를 들어, 헤더, 리스트, 코드 블록 등의 스타일을 변경하거나, 마크다운 문법 확장 기능을 사용할 수 있습니다. Marked의 공식 문서를 참고하여 원하는 옵션을 사용해보세요.

5. 마무리

Marked를 사용하여 마크다운 문서를 개발 문서로 활용하는 방법을 알아보았습니다. Marked를 활용하면 간편하게 마크다운 문서를 변환하여 다양한 목적으로 활용할 수 있습니다. 마크다운이 개발 문서 작성에 널리 사용되고 있으므로, Marked를 활용하는 것은 매우 유용한 방법입니다.

이외에도 많은 마크다운 라이브러리와 도구들이 존재하니, 본인에게 맞는 도구를 선택하여 사용해보시기 바랍니다.

참고: Marked 공식 문서