heyo-sh/heyo-docs

React Router, Next.js, Astro용 테마 적용 가능한 문서 사이트 생성 도구

설치형 도구맘대로 써도 됨 · MIT웹·Next.js·풀스택TypeScript난이도

1420 찜

3포크0이슈

중간맛 분석

TypeScript/React 기반의 프레임워크-에그노스틱 문서 생성 도구입니다. React Router, Next.js, Astro 중 선택 가능하며, 최소 설정으로 시작할 수 있습니다. MDX 지원, 내장 검색, OpenAPI 자동 레퍼런스 생성, SEO 최적화가 포함되어 있고, 다양한 테마를 선택할 수 있습니다. 즉시 사용 가능한 creator 로 프로젝트 초기화가 간단하며, 공식 데모 사이트(docs.heyo.sh)에서 결과를 확인할 수 있습니다.

이런 레포예요

이럴 때 쓰면 좋아요

API 라이브러리의 완전한 문서 사이트 구축 및 배포
팀의 개발 가이드와 튜토리얼을 한 곳에서 관리
기존 React/Next.js 애플리케이션에 문서 섹션 통합

핵심 기능

28개 이상 프레임워크/서비스 통합 지원MDX 기반 유연한 콘텐츠 작성OpenAPI 스키마로부터 자동 API 참조 페이지 생성

대안 대비 차별점

세 주요 프레임워크(React Router, Next.js, Astro)를 모두 지원하면서도 단일 설정 파일로 관리할 수 있는 프레임워크-에그노스틱 설계가 특징입니다.

먹어본 사람들

실제로 차려 먹어본 손님들의 흔적이에요 — 한마디와 완주 인증 모두 검수 후 공개돼요.

시식평 · 먹어본 사람 한마디

아직 시식평이 없어요. 먹어보셨다면 첫 한마디를 남겨주세요.

다른 레포 시식평 구경하기 →

이 레포로 만든 것들

🖋 완주 인증하기

아직 이 레포로 만든 완주 인증이 없어요. 첫 밥도장을 찍어보세요!

이 레포, 해먹는 법

처음 오셨어요? 어렵지 않아요 — 위에서 아래로 따라 하면 내 컴퓨터에 이 레포를 차려서 바로 맛볼 수 있어요.

준비물

Node.js 18 이상
pnpm/npm/Yarn/Bun 중 하나

바로 차려먹기Node.js (bun)

깃밥이 레포 구조를 확인하고 만든 실행 명령이에요. 터미널에 붙여넣으면 받기부터 실행까지 한 번에 진행돼요.

git clone --depth 1 https://github.com/heyo-sh/heyo-docs.git &&
cd heyo-docs &&
bun install &&
bun run dev

코드는 내 컴퓨터에서 실행돼요 — 처음 보는 레포라면 내용을 한번 훑어보고 실행하는 습관을 추천해요.

README가 안내하는 자세한 단계 보기

원하는 패키지 매니저(pnpm, npm, Yarn, Bun)로 creator 실행

pnpm create @heyo-sh/heyo-docs

(또는 npm: npm create @heyo-sh/heyo-docs@latest, Yarn: yarn dlx @heyo-sh/create-heyo-docs, Bun: bun create @heyo-sh/heyo-docs)

creator 프롬프트에서 프로젝트 디렉토리, 프레임워크(React Router/Next.js/Astro), 배포 타겟, 테마, 패키지 매니저 선택
완료 후 출력되는 개발 서버 시작 명령어 실행
content/ 디렉토리 아래에 MDX 페이지 추가
heyo-docs.config.ts에서 사이트 제목, 설명, 브랜딩, 네비게이션 구조 설정
공식 문서(docs.heyo.sh)에서 MDX 컴포넌트, OpenAPI, 배포 가이드 참고