모든 Mintlify 사이트에는 핵심 구성 설정이 포함된 docs.json 파일이 필요합니다. 아래에서 각 속성(Properties)에 대해 자세히 알아보세요.
속성 (Properties)
프로젝트 이름입니다. 글로벌 제목으로 사용됩니다.예: mintlify
그룹 내의 모든 페이지를 포함하는 그룹 배열입니다.
페이지 역할을 할 마크다운 파일들의 상대 경로입니다.예: ["customization", "page"]
로고 이미지의 경로 또는 “라이트” 및 “다크” 모드 로고 이미지 경로가 포함된 객체입니다.
글로벌 테마를 위한 헥사(Hex) 색상 코드
주요 색상입니다. 라이트 모드에서 강조된 콘텐츠, 섹션 헤더, 악센트 등에 가장 자주 사용됩니다.
다크 모드를 위한 주요 색상입니다. 다크 모드에서 강조된 콘텐츠, 섹션 헤더, 악센트 등에 가장 자주 사용됩니다.
상단 바(Topbar)에 포함할 링크의 name과 url 배열
버튼을 클릭했을 때의 URL입니다. 예: https://mintlify.com/docs
표시 상단 바 CTA 버튼 (Call to Action)
type
"link" or "github"
기본값:"link"
link는 버튼을 보여줍니다. github는 GitHub 스타 수를 포함하여 제공된 URL의 리포지토리 정보를 보여줍니다.
link인 경우: 버튼이 연결되는 링크입니다.github인 경우: GitHub 정보를 불러올 리포지토리 링크입니다.
버튼 내부의 텍스트입니다. type이 link인 경우에만 필수입니다.
버전 이름 배열입니다. 내비게이션 바의 드롭다운을 통해 서로 다른 버전의 문서를 보여주길 원하는 경우에만 사용하세요.
icon, color, url을 포함하는 앵커(Anchor) 배열입니다.
앵커 라벨의 이름입니다.예: Community
해당 앵커에 어떤 페이지가 들어갈지를 결정하는 URL의 시작 부분입니다. 일반적으로 페이지를 넣은 폴더의 이름입니다.
앵커 아이콘 배경의 헥사 색상입니다. 각각 헥사 색상을 값으로 가지는 from과 to 속성이 포함된 객체를 전달하여 그라데이션으로 설정할 수도 있습니다.
올바른 문서 버전이 선택될 때까지 앵커를 숨기고 싶을 때 사용합니다.
누군가 직접 내부 문서로 링크를 보내기 전까지 앵커를 숨기려면 true를 전달하세요.
“brands”, “duotone”, “light”, “sharp-solid”, “solid”, “thin” 중 하나
최상단 앵커에 대한 기본 구성을 덮어씁니다.
name
string
기본값:"Documentation"
최상단 앵커의 이름
“brands”, “duotone”, “light”, “sharp-solid”, “solid”, “thin” 중 하나
내비게이션 탭 배열입니다.
해당 탭에 어떤 페이지가 들어갈지를 결정하는 URL의 시작 부분입니다. 일반적으로 페이지를 넣은 폴더의 이름입니다.
API 설정을 위한 구성입니다. API 페이지에 대한 자세한 내용은 API 컴포넌트에서 확인하세요.
모든 API 엔드포인트의 기본 URL입니다. baseUrl이 배열인 경우 사용자가 전환할 수 있는 여러 기본 URL 옵션이 활성화됩니다.
method
"bearer" | "basic" | "key"
모든 API 엔드포인트에 사용되는 인증 전략입니다.
API 플레이그라운드에서 사용되는 인증 매개변수의 이름입니다.메서드가 basic인 경우 형식은 [usernameName]:[passwordName]이어야 합니다.
인증 입력 필드의 접두사로 설계된 기본값입니다.예: inputPrefix가 AuthKey이면 인증 필드의 기본 입력 결과는 AuthKey를 상속합니다.
API 플레이그라운드를 위한 구성
mode
"show" | "simple" | "hide"
기본값:"show"
플레이그라운드를 표시할지, 숨길지, 아니면 사용자 상호작용 없이 엔드포인트만 표시할지(simple) 여부입니다.더 자세한 내용은 플레이그라운드 가이드를 참조하세요. 이 플래그를 활성화하면 OpenAPI 페이지의 키 순서가 OpenAPI 파일에 정의된 키 순서와 일치하도록 보장합니다.이 동작은 곧 기본적으로 활성화될 예정이며, 그 시점에 이 필드는 더 이상 사용되지(Deprecated) 않을 것입니다.
OpenAPI 파일을 가리키는 URL 또는 상대 경로 문자열 또는 문자열 배열입니다.예시:"openapi": "https://example.com/openapi.json"
소셜 미디어 계정 객체로, 키:속성 쌍은 소셜 미디어 플랫폼과 계정 URL을 나타냅니다.예시:{
"x": "https://x.com/mintlify",
"website": "https://mintlify.com"
}
표시 하단 소셜 링크 (FooterSocials)
website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news 중 하나의 값입니다.예: x
소셜 플랫폼으로 연결되는 URL입니다.예: https://x.com/mintlify
피드백 버튼을 활성화하기 위한 구성
사용자가 풀 리퀘스트를 통해 편집을 제안할 수 있는 버튼을 활성화합니다.
사용자가 문서에 대한 이슈를 제기할 수 있는 버튼을 활성화합니다.
다크 모드 토글을 맞춤 설정합니다.
새 사용자에게 항상 라이트 또는 다크 모드를 보여주고 싶을 때 설정합니다. 설정하지 않으면 사용자의 운영 체제와 동일한 모드를 기본값으로 사용합니다.
다크/라이트 모드 토글을 숨기려면 true로 설정하세요. isHidden과 default를 결합하여 문서가 라이트 모드 또는 다크 모드만 사용하도록 강제할 수 있습니다. 예를 들어:"modeToggle": {
"default": "dark",
"isHidden": true
}
