소개
Onedocs은 Next.js 및 Fumadocs로 만든 문서 사이트용 레이아웃, 컴포넌트 및 헬퍼 모음입니다. Markdown를 작성하고 사이트를 구성 파일 하나로 설명하면 Onedocs가 문서 사이트 기본 틀, 홈페이지 및 SEO 라우트를 제공합니다.
기존 애플리케이션에 문서를 추가하는 용도가 아니라 독립형 문서 웹사이트를 위한 도구입니다.
Onedocs이 제공하는 기능
Fumadocs 외에도 onedocs 패키지가 다음 기능을 제공합니다:
- 레이아웃 -
DocsLayout및DocsPage은 사이드바, 검색, 테마 전환 및 목차가 포함된 Fumadocs UI 문서 레이아웃을 감쌉니다.HomePage는 히어로, 설치 명령, 기능 및 푸터가 있는 랜딩 페이지를 렌더링합니다. - 구성 파일 하나 -
onedocs.config.ts에 제목, 설명, 로고, 파비콘, 탐색 링크, 푸터 및 홈페이지 콘텐츠를 지정합니다. - MDX 컴포넌트 -
mdxComponents가 안내 상자, 탭, 카드, 단계, 아코디언, 파일 트리, 이미지 확대 및 타입 표를 등록하므로 페이지에서 가져오기 없이 사용할 수 있습니다. - CSS 프리셋 - 한 번 가져오면 Tailwind CSS v4, Fumadocs UI 테마 및 Onedocs 레이아웃 스타일을 불러옵니다.
- SEO 헬퍼 -
sitemap.xml,robots.txt,llms.txt,llms-full.txt, 페이지 메타데이터 및 Open Graph 이미지용 함수입니다.
직접 설정해야 하는 항목
Onedocs에는 Next.js 또는 Fumadocs가 포함되어 있지 않습니다. 피어 종속성이므로 함께 설치해야 합니다:
셸
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom
또한 Tailwind CSS v4, Node.js 20.9 이상과 작은 파일 약 10개가 필요합니다. 여기에는 Next.js 및 Fumadocs MDX 구성, 콘텐츠 소스, 루트 레이아웃, 문서 레이아웃 및 문서 페이지 라우트가 포함됩니다. 각 파일은 시작하기에서 확인할 수 있습니다.
설정 위치
| 항목 | 위치 |
|---|---|
| 사이트 제목, 로고, 탐색 메뉴, 푸터 | onedocs.config.ts, 구성 참조 |
| 홈페이지 히어로 및 기능 | onedocs.config.ts의 homepage, src/app/page.tsx의 HomePage가 렌더링 |
| 문서 레이아웃 및 페이지 | src/app/docs/layout.tsx 및 src/app/docs/[[...slug]]/page.tsx, 시작하기 참조 |
| 콘텐츠 폴더 및 사이드바 순서 | source.config.ts 및 content/docs/meta.json |
| MDX 컴포넌트 | mdxComponents, 컴포넌트 참조 |
| 검색, 사이트맵, robots.txt, llms.txt | src/app/ 아래 라우트 파일, SEO 및 검색 참조 |
| 메타데이터 및 Open Graph 이미지 | onedocs/metadata 및 onedocs/og, API 레퍼런스 참조 |
철학
- Markdown-first -
.md또는.mdx를 작성하면 문서가 생성됩니다 - 단일 설정 파일 - 사이트 전체 설정은
onedocs.config.ts에 저장됩니다 - 확장 방법 - 더 세밀하게 제어해야 하나요? Fumadocs를 직접 사용하세요