Blog

민트리피 Docs란 무엇이며 어떻게 사용하나요: 초보자 가이드

Ashley Goolam

Ashley Goolam

4 June 2025

민트리피 Docs란 무엇이며 어떻게 사용하나요: 초보자 가이드

번거롭게 느껴지지 않는 매끄럽고 사용자 친화적인 문서를 만드는 데 어려움을 겪고 계신가요? 블로그 글 작성만큼이나 멋진 문서를 쉽게 만들 수 있게 해주는 AI 기반 플랫폼인 Mintlify를 만나보세요. 28,000개 이상의 GitHub 스타와 Stripe와 같은 고객사를 보유한 Mintlify는 대화형 기능, AI 도구, 원활한 통합 기능을 제공하여 문서 수준을 한 단계 높여줍니다. 이 초보자 가이드에서는 Mintlify 설치, 사용자 지정 도메인 설정, AI 수집 활용, MCP 서버 통합, 번역 추가, API 문서를 위한 OpenAPI 사용 방법에 대해 자세히 설명합니다. 개발자든 팀 리더든 상관없이 금방 전문가 수준의 문서를 만들 수 있습니다. 문서 작업을 재미있게 만들 준비가 되셨나요? 시작해 봅시다!

💡
시작하기 전에, API 개발을 간소화하고 싶다면 Apidog가 API 설계, 테스트 및 문서를 위한 올인원 플랫폼을 제공합니다. 직관적인 인터페이스와 강력한 기능으로 초보자와 숙련된 개발자 모두에게 완벽합니다. 무엇보다 무료로 시작할 수 있습니다! (apidog)
button

Mintlify란 무엇인가요? 당신의 문서 슈퍼파워

Mintlify는 개발자가 최소한의 노력으로 아름답고 대화형이며 SEO 친화적인 문서를 만들 수 있도록 돕는 현대적인 문서 플랫폼입니다. 팀 및 오픈 소스 프로젝트를 위해 구축되었으며, Markdown 및 MDX 파일을 반응형 페이지로 렌더링하고, GitHub 통합을 지원하며, 코드 생성 및 번역과 같은 AI 기반 기능을 포함합니다. 주요 이점은 다음과 같습니다.

드래그 앤 드롭 워크플로우와 40% 더 높은 사용자 전환율을 갖춘 Mintlify는 스타트업이나 공개 프로젝트에 완벽합니다. 설정해 봅시다.

mintlify.com

Mintlify 설치 및 설정

Mintlify를 시작하는 것은 매우 쉽고, Node.js, Mintlify CLI, GitHub 계정이 필요합니다. 공식 가이드에 따라 시작하는 방법은 다음과 같습니다.

1. 사전 요구 사항 설치:

2. 스타터 키트 클론:

git clone https://github.com/mintlify/starter-kit
cd starter-kit

3. Mintlify CLI 설치:

npm install -g mintlify-cli

4. 로컬 미리 보기 실행:

mintlify-cli dev

5. 문서 편집:

{
  "name": "My Docs",
  "theme": "prism",
  "colors": { "primary": "#3498db" }
}

10분도 안 되어 설정하고 제가 수정한 내용이 반영된 라이브 사이트를 만들었습니다. 정말 매끄러웠습니다!

Mintlify를 위한 사용자 지정 도메인 설정

문서를 mintlify.app 하위 도메인 대신 docs.yourcompany.com에 호스팅하고 싶으신가요? Mintlify는 사용자 지정 도메인을 쉽게 설정할 수 있도록 합니다.

1. 설정 접근:

custom domain

2. 도메인 추가:

cname

3. 전파 대기:

테스트 사이트에 사용자 지정 도메인을 설정했는데 몇 시간 만에 라이브 상태가 되었습니다. 완전히 전문가 느낌이었습니다!

Mintlify에서 AI 수집 활용

Mintlify의 AI 수집은 문서를 더 스마트하고 접근하기 쉽게 만들어 사용자가 AI 기반 쿼리를 통해 콘텐츠를 검색할 수 있도록 합니다.

1. AI 수집 활성화:

ai chat

2. AI 검색 테스트:

3. AI 수정으로 향상:

샘플 사이트에서 AI 검색을 시도했는데 API 문서를 즉시 찾았습니다. 수동으로 찾아보는 것보다 훨씬 빨랐습니다!

Mintlify와 MCP 서버 통합

MCP(Model Context Protocol)를 사용하면 AI 앱이 문서 또는 API와 상호 작용할 수 있습니다. Mintlify는 콘텐츠를 LLM과 연결하는 MCP 서버를 생성합니다.

1. MCP CLI 설치:

npm i @mintlify/mcp

2. MCP 서버 구성:

3. MCP 서버 사용:

로컬에 Mintlify MCP 서버 설치

Mintlify MCP 서버를 로컬 머신에서 실행하려면:

npx @mintlify/mcp add mintlify
install mintlify locally

예시: 저는 Windsurf를 사용했고 터미널에 다음이 표시되었습니다:

node C:\User\Me.mcp\mintlify\src\index.js
mcp command

샘플 프롬프트 (Windsurf에서):

이 PRD를 기반으로 AppleDB 문서의 스타일과 톤으로 이 기능에 대한 도움말 문서를 작성해줘.

또는 Mintlify 호환 형식으로:

앵커와 같은 Mintlify 구성 요소를 사용하여 마크다운으로 작성해줘.
run in mcp client

MCP 서버를 설정했는데 AI 비서가 전문가처럼 문서를 쿼리할 수 있게 되었습니다. 미래 지향적인 기능입니다!

Mintlify 문서에 번역 추가

문서를 여러 언어로 제공하고 싶으신가요? Mintlify의 AI 기반 번역은 현지화를 쉽게 만듭니다.

1. 번역 활성화:

mintlify translation

2. 번역 사용자 지정:

3. 번역 테스트:

switch between languages

스페인어 번역을 추가했는데 몇 분 만에 문서가 글로벌 준비 상태가 되었습니다. 접근성 측면에서 큰 이점입니다!

view all languages

VS Code에서 Mintlify 사용

VS Code에서 코드를 문서화하시나요? Mintlify 확장 프로그램은 이를 쉽게 만듭니다!

1. Mintlify 확장 프로그램 설치:

vs code mintlify extension

2. 문서 생성:

샘플 코드:

test("@e2e wait for api response", async ({ page }) => {
  const sidemenuPage = new SideMenuPage(page);
  await sidemenuPage.interceptApiLink.click();
  const response = await page.waitForResponse((response) =>
    response.url().includes("/comments")
  );
  expect(response.status()).toBe(200);
  await page.getByText("CREATE post").isVisible();
});

생성된 문서:

이 코드 블록은 API 응답이 성공적으로 수신되는지 확인하는 테스트 케이스입니다.
use mintlify in vs code

테스트 스크립트를 문서화했는데 Mintlify가 설명을 정확하게 작성했습니다. 정말 수고를 덜어주었습니다!

Mintlify 기능 탐색

Mintlify는 문서를 빛나게 만드는 도구로 가득합니다. 수준을 높이는 방법은 다음과 같습니다.

테마를 조정하고 탭을 추가했는데 문서가 한 시간도 안 되어 전문가 디자인처럼 보였습니다!

마무리: Mintlify 여정 시작

잘하셨습니다! 멋진 AI 지원 문서를 만들기 위한 Mintlify의 힘을 얻으셨습니다! CLI 설치부터 사용자 지정 도메인 설정, AI 수집, MCP 서버, 번역, OpenAPI 플레이그라운드까지, 사용자에게 감동을 주는 문서를 만들 준비가 되었습니다. 새로운 구성 요소를 실험하거나, 더 많은 언어를 추가하거나, APIdog로 API 문서를 작성해 보세요! 즐거운 문서 작업 되세요!

button

Apidog에서 API 설계-첫 번째 연습

API를 더 쉽게 구축하고 사용하는 방법을 발견하세요

무료 회원가입다운로드