Skip to main content
BarodocBarodoc
GitHub
3 min read

시작하기

빠른 시작

5분 안에 Barodoc 문서 사이트 만들기

CLI(제로 설정)로 새 문서 사이트를 만듭니다. 프로젝트에 package.json이나 node_modules가 없습니다.

필요 환경

  • Node.js 20 이상
  • pnpm 권장

프로젝트 생성

pnpm create barodoc my-docs
cd my-docs

Markdown과 설정만 있는 프로젝트가 생성됩니다. Astro 설정이나 의존성은 프로젝트 폴더에 없습니다.

프로젝트 구조 (CLI / 제로 설정)

생성 후 디렉터리 구조:

my-docs/
├── docs/
│   └── en/
│       ├── introduction.md
│       └── quickstart.md
├── public/
│   └── logo.svg
├── barodoc.config.json
└── .gitignore
  • docs/ – 로케일별 콘텐츠 (en/, ko/ 등). 파일 경로 = URL 슬러그 (예: en/introduction.md → /docs/introduction).
  • public/ – 정적 파일 (로고, 파비콘, 이미지).
  • barodoc.config.json – 사이트 이름, 네비게이션, 테마, i18n.

이 모드에서는 src/, package.json, astro.config.mjs가 없습니다.

개발 서버

npx barodoc serve

사이트가 실행됩니다 (예: http://localhost:4321). CLI가 .barodoc/ 아래에 임시 Astro 프로젝트를 만들고 dev 서버를 띄웁니다. 수정하는 것은 docs/와 barodoc.config.json뿐입니다.

빌드

npx barodoc build

결과물은 dist/(또는 설정에서 지정한 경로)에 생성됩니다. 이 폴더를 GitHub Pages, Vercel, Netlify, Cloudflare Pages 등 정적 호스팅에 배포하면 됩니다.

빌드 미리보기

npx barodoc preview

dist/ 결과물을 로컬에서 띄워 프로덕션 빌드를 확인할 수 있습니다.

페이지 추가하기

  1. docs/en/ 아래에 파일 추가 (예: docs/en/guides/installation.md).
  2. barodoc.config.json의 navigation에 슬러그 추가:
{
  "navigation": [
    { "group": "시작하기", "pages": ["introduction", "quickstart"] },
    { "group": "가이드", "pages": ["guides/installation"] }
  ]
}

슬러그 = 로케일과 확장자를 뺀 경로: guides/installation.md → guides/installation. 접을 수 있는 사이드바 그룹(예: “설정” 섹션)은 설정 → 네비게이션을 참고하세요.

풀 커스텀 (Astro) 모드

Astro 프로젝트 전체가 필요한 경우(커스텀 페이지, 다른 통합 등) 설치 → 수동 설치를 참고하세요. 그 방식은 src/content/docs/, astro.config.mjs를 사용하고 pnpm dev / pnpm build로 실행합니다. 이 저장소의 docs/ 사이트가 그 예입니다.

다음 단계

Linked pages

Linked from