글로벌 설정

모든 Mintlify 사이트에는 핵심 구성 설정이 포함된 docs.json 파일이 필요합니다. 아래 속성에 대해 자세히 알아보세요.

속성

namestringrequired

프로젝트 이름. 글로벌 제목에 사용됩니다.

예시: mintlify

navigationNavigation[]required

해당 그룹 내의 모든 페이지가 포함된 그룹 배열

탐색

groupstring

그룹 이름.

예시: Settings

pagesstring[]

페이지 역할을 하는 마크다운 파일에 대한 상대 경로.

예시: ["customization", "page"]

logostring or object

로고 이미지 경로 또는 "light"와 "dark" 모드 로고 이미지 경로가 포함된 객체

로고

lightstring

라이트 모드의 로고 경로

darkstring

다크 모드의 로고 경로

hrefstring

로고 클릭 시 이동하는 곳

faviconstring

파비콘 이미지 경로

colorsColors

글로벌 테마의 16진수 색상 코드

색상

primarystringrequired

기본 색상. 주로 강조된 콘텐츠, 섹션 헤더, 악센트에 사용됩니다. 라이트 모드에서 사용됩니다.

lightstring

다크 모드의 기본 색상. 주로 강조된 콘텐츠, 섹션 헤더, 악센트에 사용됩니다. 다크 모드에서 사용됩니다.

darkstring

중요한 버튼의 기본 색상

backgroundobject

라이트 및 다크 모드 모두에서 배경색

객체

lightstringrequired

라이트 모드의 배경 16진수 색상 코드

darkstringrequired

다크 모드의 배경 16진수 색상 코드

topbarLinksTopbarLink[]

탑바에 포함하려는 링크의 name과 url 배열

탑바링크

namestring

버튼 이름.

예시: Contact us

urlstring

버튼 클릭 시 URL. 예시: https://mintlify.com/docs

topbarCtaButtonCall to Action

탑바 호출 액션

type"link" or "github"

링크는 버튼을 표시합니다. GitHub는 제공된 URL에서 GitHub 스타 수를 포함한 리포지토리 정보를 표시합니다.

urlstring

link의 경우: 버튼이 링크되는 곳.

github의 경우: GitHub 정보를 가져올 리포지토리에 대한 링크.

namestring

버튼 안의 텍스트. type이 link인 경우에만 필수입니다.

versionsstring[]

버전 이름 배열. 탐색 모음의 드롭다운으로 다른 버전의 문서화를 표시하려는 경우에만 사용합니다.

anchorsAnchor[]

앵커 배열, icon, color 및 url을 포함합니다.

앵커

iconstring

앵커를 표시하는 데 사용되는 Font Awesome 아이콘.

예시: comments

namestring

앵커 레이블 이름.

예시: Community

urlstring

어떤 페이지가 앵커에 들어가는지 표시하는 URL의 시작 부분. 일반적으로 페이지를 넣은 폴더 이름입니다.

colorstring

앵커 아이콘 배경의 16진수 색상. from과 to가 각각 16진수 색상인 객체를 전달하면 그라디언트가 될 수도 있습니다.

versionstring

올바른 문서화 버전이 선택될 때까지 앵커를 숨기려는 경우에 사용합니다.

isDefaultHiddenboolean

앵커 내부의 문서화에 직접 연결할 때까지 앵커를 숨기려면 true를 전달합니다.

iconTypestring

다음 중 하나: "brands", "duotone", "light", "sharp-solid", "solid" 또는 "thin"

topAnchorObject

최상위 앵커의 기본 구성을 재정의합니다.

객체

namestring

최상위 앵커 이름

iconstring

Font Awesome 아이콘.

iconTypestring

다음 중 하나: "brands", "duotone", "light", "sharp-solid", "solid" 또는 "thin"

tabsTabs[]

탐색 탭 배열.

탭

namestring

탭 레이블 이름.

urlstring

어떤 페이지가 탭에 들어가는지 표시하는 URL의 시작 부분. 일반적으로 페이지를 넣은 폴더 이름입니다.

apiAPI

API 설정 구성. API 페이지에 대해 자세히 알아보려면 API 컴포넌트를 참조하세요.

API

baseUrlstring

모든 API 엔드포인트의 기본 URL. baseUrl이 배열이면 사용자가 토글할 수 있는 여러 기본 URL 옵션이 활성화됩니다.

authAuth

인증

method"bearer" | "basic" | "key"

모든 API 엔드포인트에 사용되는 인증 전략.

namestring

API 플레이그라운드에서 사용되는 인증 매개변수 이름.

basic인 경우 형식은 [usernameName]:[passwordName]이어야 합니다.

inputPrefixstring

인증 입력 필드의 접두사로 설계된 기본 값.

예: AuthKey의 inputPrefix는 인증 필드의 기본 입력 결과를 AuthKey로 상속합니다.

playgroundPlayground

API 플레이그라운드 구성

플레이그라운드

mode"show" | "simple" | "hide"

플레이그라운드가 표시되는지, 숨겨지는지 또는 추가 사용자 상호작용 없이 엔드포인트만 표시하는지 simple

자세히 알아보려면 플레이그라운드 가이드를 참조하세요

maintainOrderboolean

이 플래그를 활성화하면 OpenAPI 페이지의 키 순서가 OpenAPI 파일에 정의된 키 순서와 일치하도록 보장됩니다.

경고

이 동작은 곧 기본적으로 활성화되며, 그 시점에서 이 필드는 더 이상 사용되지 않습니다.

openapistring | string[]

OpenAPI 파일을 가리키는 URL 또는 상대 경로의 문자열 또는 문자열 배열.

예시:

"openapi": "https://example.com/openapi.json"

"openapi": "/openapi.json"

"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]

footerSocialsFooterSocials

소셜 미디어 계정 객체로, 키:속성 쌍이 소셜 미디어 플랫폼과 계정 URL을 나타냅니다.

예시:

{
  "x": "https://x.com/mintlify",
  "website": "https://mintlify.com"
}

푸터소셜

[key]string

다음 값 중 하나: website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news

예시: x

propertystring

소셜 플랫폼에 대한 URL.

예시: https://x.com/mintlify

feedbackFeedback

피드백 버튼 활성화 구성

피드백

suggestEditboolean

사용자가 풀 리퀘스트를 통해 편집을 제안할 수 있는 버튼 활성화

raiseIssueboolean

사용자가 문서화에 대해 이슈를 제기할 수 있는 버튼 활성화

modeToggleModeToggle

다크 모드 토글 사용자 지정.

모드토글

default"light" or "dark"

새 사용자에게 항상 라이트 또는 다크 모드를 표시하려면 설정합니다. 설정하지 않으면 사용자의 운영 체제와 동일한 모드로 기본 설정됩니다.

isHiddenboolean

다크/라이트 모드 토글을 숨기려면 true로 설정합니다. isHidden을 default와 결합하여 문서화가 라이트 또는 다크 모드만 사용하도록 강제할 수 있습니다. 예시:

"modeToggle": {
  "default": "dark",
  "isHidden": true
}

"modeToggle": {
  "default": "light",
  "isHidden": true
}

backgroundImagestring

모든 페이지 뒤에 표시되는 배경 이미지. Infisical과 FRPC의 예시를 참조하세요.

속성​

속성