소개
Fumadocs (Foo-ma docs)는 Next.js 기반 문서 프레임워크입니다. 빠르고 유연하며 Next.js App Router에 자연스럽게 녹아듭니다.
Fumadocs는 여러 부분으로 나뉩니다.
Fumadocs Core
문서 검색, 콘텐츠 소스 어댑터, Markdown 확장을 포함한 핵심 로직을 담당합니다.
Fumadocs UI
Fumadocs의 기본 테마로, 문서 사이트와 대화형 구성 요소에 맞는 화면을 제공합니다.
Content Source
콘텐츠의 출처입니다. CMS이거나 Fumadocs MDX(공식 콘텐츠 소스) 같은 로컬 데이터 계층일 수 있습니다.
Fumadocs CLI
UI 구성 요소를 설치하고 작업을 자동화하는 명령줄 도구입니다. 레이아웃을 바꿀 때 유용합니다.
더 알고 싶으신가요?
Fumadocs란 소개를 읽어 보세요.
용어
Markdown/MDX: Markdown은 서식 있는 텍스트를 만드는 마크업 언어입니다. Fumadocs는 Markdown과 MDX(Markdown의 상위 집합)를 기본으로 지원합니다.
필수는 아니지만, 더 깊이 수정하려면 Next.js App Router의 기본을 알아 두면 도움이 됩니다.
자동 설치
Node.js 18 이상이 필요합니다. Node.js 23.1은 Next.js 프로덕션 빌드에서 문제가 있을 수 있습니다.
npm create fumadocs-app다음을 물어봅니다.
- 사용할 React.js 프레임워크(문서는 Next.js만 다룹니다).
- 사용할 콘텐츠 소스.
새 Fumadocs 앱이 초기화됩니다. 이제 바로 수정해 볼 수 있습니다.
기존 코드베이스에서 시작하나요?
수동 설치 가이드를 따라 시작할 수 있습니다.
시작하기
docs 폴더에 첫 MDX 파일을 만듭니다.
---
title: Hello World
---
## Yo what's up개발 모드로 앱을 실행하고 http://localhost:3000/docs 를 확인합니다.
npm run dev자주 묻는 질문
자주 만나는 질문입니다.
Fumadocs 업그레이드
문제가 생기거나 새 기능을 시험할 때는 Fumadocs를 업그레이드하세요.
pnpm update -i -r --latest자세히 알아보기
처음이어도 괜찮습니다. 질문은 언제든 환영합니다.
헷갈리는 부분이 있으면 Github Discussion에 의견을 남겨 주세요.
콘텐츠 작성
문서를 작성하기 전에 다음을 읽어 보세요.
Markdown
Fumadocs에는 콘텐츠 작성에 쓰는 추가 기능이 있습니다.
Navigation
탐색 링크와 사이드바 항목을 바꾸는 방법입니다.
Routing
콘텐츠를 구성하는 방법입니다.
Components
문서를 보강하는 구성 요소