가이드

설치

Barodoc 설치: CLI(제로 설정) 또는 수동 Astro 설정

Barodoc을 쓰는 방법은 두 가지입니다. **CLI(제로 설정)**은 문서 전용 프로젝트용이고, **수동(Astro)**은 Astro 앱 전체를 쓰는 경우입니다.

CLI (제로 설정, 새 문서 사이트 권장)

프로젝트에 package.json이나 Astro 설정이 없습니다. docs/, public/, barodoc.config.json만 있습니다.

프로젝트 생성

pnpm create barodoc my-docs
cd my-docs

생성되는 구조

프로젝트 안에는 src/나 astro.config.mjs가 없습니다. 명령 실행 시 CLI가 .barodoc/ 아래에 임시 Astro 프로젝트를 만듭니다.

명령어

# 개발
npx barodoc serve

# 선택: 포트/설정 파일 지정
npx barodoc serve --port 3000
npx barodoc serve --config custom.config.json

# 프로덕션 빌드 (결과: dist/)
npx barodoc build

# 빌드 미리보기
npx barodoc preview

프로젝트 안에서 별도 설치 없이 npx barodoc으로 실행합니다.

수동 설치 (Astro 통합)

일반 Astro 프로젝트가 필요할 때(커스텀 라우트, 다른 통합 등) 사용합니다. 콘텐츠는 src/content/docs/에 두고 pnpm dev / pnpm build로 실행합니다.

1. Astro 프로젝트 생성

pnpm create astro@latest my-docs
cd my-docs

2. Barodoc 패키지 설치

pnpm add @barodoc/core @barodoc/theme-docs astro

3. Astro 설정

astro.config.mjs에 다음을 추가합니다:

import { defineConfig } from "astro/config";
import barodoc from "@barodoc/core";
import docsTheme from "@barodoc/theme-docs";

export default defineConfig({
  integrations: [
    barodoc({
      config: "./barodoc.config.json",
      theme: docsTheme(),
    }),
  ],
});

4. 설정 파일 생성

프로젝트 루트에 barodoc.config.json 생성:

{
  "name": "My Docs",
  "logo": "/logo.svg",
  "navigation": [
    {
      "group": "시작하기",
      "pages": ["introduction", "quickstart"]
    }
  ],
  "i18n": {
    "defaultLocale": "en",
    "locales": ["en"]
  }
}

5. 콘텐츠 추가

src/content/docs/en/introduction.mdx를 만들고, 필요하면 src/content/docs/ko/ 등 다른 로케일도 추가합니다. 구조와 슬러그는 콘텐츠 구조를 참고하세요.

---
title: 소개
description: 문서에 오신 것을 환영합니다
---

# 환영합니다

문서 내용을 여기에 작성하세요.

6. 실행

pnpm dev
pnpm build

콘텐츠 구조와 URL 규칙은 CLI 모드와 동일하고, 디렉터리만 docs/ 대신 src/content/docs/를 사용합니다.