Mintlify

Mintlify란 무엇인가요?

Mintlify는 아름답고 커스터마이징 가능한 문서 사이트를 생성하는 문서화 플랫폼입니다. 현대적인 개발자 문서를 구축하기 위한 내장 검색, 분석 및 API 플레이그라운드 기능을 제공합니다.

Lingo.dev CLI란 무엇인가요?

Lingo.dev는 AI 기반 번역 플랫폼입니다. Lingo.dev CLI는 소스 파일을 읽고, 번역 가능한 콘텐츠를 대규모 언어 모델에 전송한 후, 번역된 파일을 프로젝트에 다시 작성합니다.

이 가이드에 대하여

이 가이드는 Mintlify 문서 사이트에서 Lingo.dev CLI를 설정하는 방법을 설명합니다. Mintlify로 프로젝트를 스캐폴딩하고, 번역 파이프라인을 구성하며, 결과를 확인하는 방법을 배우게 됩니다.

1단계. Mintlify 프로젝트 설정

1. Mintlify CLI를 설치하세요:

   npm i -g mint
   

2. Mintlify 스타터 템플릿을 클론하세요:

   git clone https://github.com/mintlify/starter.git
   

3. 프로젝트 디렉토리로 이동하세요:

   cd starter
   

2단계. 소스 콘텐츠 생성

1. 소스 로케일의 문서를 저장할 디렉토리를 생성하세요:

   mkdir en
   

2. 문서 콘텐츠가 포함된 파일을 생성하세요(예: en/overview.mdx):

   ---
   title: "Introduction"
   description: "Welcome to the new home for your documentation"
   ---
   
   ## Getting started
   
   This documentation is automatically translated by Lingo.dev.
   
   ## Features
   
   Our product includes powerful capabilities for modern development.
   

3단계. CLI 구성

프로젝트 루트에 i18n.json 파일을 생성하세요:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "mdx": {
      "include": ["[locale]/*.mdx", "[locale]/*/*.mdx"]
    }
  }
}

이 파일은 다음을 정의합니다:

• Lingo.dev CLI가 번역해야 하는 파일
• 번역할 언어

이 경우 구성은 MDX 파일을 영어에서 스페인어로 번역합니다.

다음 사항에 유의해야 합니다:

• [locale]는 런타임에 대체되는 플레이스홀더입니다. 이를 통해 콘텐츠를 한 위치(예: en/index.mdx)에서 읽고 다른 위치(예: es/index.mdx)에 작성할 수 있습니다.
• Lingo.dev CLI는 재귀적 glob 패턴(예: **/*.mdx)을 지원하지 않습니다. 중첩된 디렉토리 내에 있는 파일을 번역하려면 추가 include 패턴을 생성해야 합니다.

자세한 내용은 i18n.json 구성을 참조하세요.

4단계. 콘텐츠 번역하기

1. Lingo.dev 계정에 가입하세요.

2. CLI를 통해 Lingo.dev에 로그인하세요:

   npx lingo.dev@latest login
   

3. 번역 파이프라인을 실행하세요:

   npx lingo.dev@latest run
   

   CLI는 번역된 콘텐츠를 저장하기 위한 es/ 디렉토리와 번역된 내용을 추적하기 위한 i18n.lock 파일을 생성합니다(불필요한 재번역을 방지하기 위함).

5단계. 번역 사용하기

1. docs.json 파일에서 navigation 객체에 languages 속성을 추가하세요:

   {
     "navigation": {
       "languages": []
     }
   }
   

2. 지원되는 각 언어에 대해 배열에 별도의 객체를 추가하세요:

   {
     "navigation": {
       "languages": [
         {
           "language": "en",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["en/overview"]
             }
           ]
         },
         {
           "language": "es",
           "groups": [
             {
               "group": "Getting started",
               "pages": ["es/overview"]
             }
           ]
         }
       ]
     }
   }
   

   다음 사항에 유의하세요:

   • 각 언어에 대해 전체 내비게이션 구조를 별도로 복제해야 합니다.
   • Mintlify는 Lingo.dev CLI가 지원하는 언어의 일부만 지원합니다.

3. 개발 서버를 시작하세요:

   mint dev
   

4. http://localhost:3000으로 이동하세요. 언어 전환을 위한 드롭다운이 표시됩니다.

알려진 제한 사항

• docs.json 파일에 정의된 UI 텍스트(예: 사이드바 그룹 레이블, 검색 플레이스홀더 텍스트 등)는 번역되지 않습니다.

지원되는 언어

Mintlify는 Lingo.dev CLI가 지원하는 언어의 일부만 지원합니다. 최신 목록은 공식 문서를 참조하세요.