가이드

마이그레이션 가이드

다른 문서 프레임워크에서 Barodoc으로 마이그레이션하는 방법을 안내합니다.

다른 문서 프레임워크에서 Barodoc으로 이전하시나요? 주요 차이점과 단계를 안내합니다.

Docusaurus에서 이전

barodoc create my-docs

Markdown/MDX 파일을 docs/en/ (또는 해당 로캘 폴더)으로 복사합니다.

cp -r old-project/docs/* my-docs/docs/en/

Docusaurus의 sidebar_position, sidebar_label은 Barodoc에서 barodoc.config.json으로 대체됩니다:

---
- sidebar_position: 1
- sidebar_label: "시작하기"
+ title: 시작하기
---

Docusaurus의 sidebars.js를 barodoc.config.json의 navigation으로 대체합니다:

{
  "navigation": [
    {
      "group": "시작하기",
      "pages": ["introduction", "quickstart"]
    }
  ]
}

Docusaurus	Barodoc
`:::note` / `:::tip` / `:::warning`	`<Callout type="note">` / `<Callout type="tip">` / `<Callout type="warning">`
`<Tabs>` / `<TabItem>`	`<Tabs>` / `<Tab>`
`<details>`	`<Accordion>`

Barodoc은 Mintlify와 호환되도록 설계되어 대부분의 컴포넌트가 그대로 동작합니다.

MDX 파일을 docs/en/으로 복사합니다.

// mint.json → barodoc.config.json
{
-  "colors": { "primary": "#0070f3" }
+  "theme": { "colors": { "primary": "#0070f3" } }
}

Card, Tabs, Steps, Accordion, CodeGroup, ParamField, ResponseField 등은 변경 없이 사용 가능합니다.

Tip

Mintlify 컴포넌트 대부분이 Barodoc에서 변경 없이 동작합니다.