Aria Docs

Ariadocs- 문서 템플릿

Next.js로 제작 된이 기능으로 가득 찬 문서 템플릿은 매끄럽고 반응이 좋은 디자인을 제공하며 모든 프로젝트 문서 요구에 적합합니다.

다음은 Ariadocs 템플릿의 모든 버전입니다. 각 버전은 특정 사용 사례를 위해 제작되었습니다.

• 고급 문서 : 심층적 인 문서화 요구에 대한 광범위한 기능을 제공하는 포괄적 인 템플릿. 자세한 설명과 고급 구성이 필요한 대규모 프로젝트에 적합합니다.
  고급 문서를 탐색하십시오

• LITE 버전 : 간단한 문서화 요구에 적합한 간소화되지 않은 템플릿.
  라이트 버전을 탐색하십시오

• 버전 관리 버전 : 과거 문서 추적이 필요한 프로젝트를위한 강력한 옵션. 문서의 여러 버전을 쉽게 관리합니다.
  버전 관리 기능을 확인하십시오

• I18N 지원 버전 (WIP) : 국제 관객을 위해 설계된이 버전은 포괄적 인 다국어 지원을 제공합니다.
  i18N 지원을 미리보십시오

빠른 시작

명령을 사용하여 새로운 Ariadocs 프로젝트를 만들 수 있습니다.

 npx create-aria-doc <project-directory>

예상 출력

CLI를 실행하면 다음과 유사한 출력을 기대할 수 있습니다.

 Creating a new Ariadocs project in /path/to/your/project from the master branch...
Cloning Master (Full Documentation)...
Ariadocs project successfully created in /path/to/your/project!

Next steps:
1. Navigate to your project directory:
   cd <project-directory>
2. Install dependencies:
   // To support React 19, package maintainers will need to test and update their packages to include React 19 as a peer dependency. This is already in progress.
   npm install --force 
3. Start the development server:
   npm run dev

시작하기

먼저 개발 서버를 실행합니다.

 npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Vercel에 배포하십시오

Next.js 앱을 배포하는 가장 쉬운 방법은 Next.js의 제작자의 Vercel 플랫폼을 사용하는 것입니다.

자세한 내용은 Next.js 배포 문서를 확인하십시오.

주요 기능

특징	설명
MDX 지원	MDX로 대화식 문서를 작성하십시오.
중첩 된 페이지	중첩 된 계층 구조로 내용을 구성하십시오.
블로그 섹션	전용 블로그 섹션을 포함하십시오.
목차	쉬운 내비게이션을 위해 자동 생성 된 TOC.
쪽수 매기기	여러 페이지에서 콘텐츠를 분할하십시오.
구문 강조 표시	더 나은 가독성을위한 강조 표시.
코드 라인 강조 및 제목	설명 제목으로 특정 라인을 강조 표시하십시오.
대화식 코드 블록	언어 별 및 대화식 코드 표시.
맞춤 구성 요소	문서에 맞춤형, 재사용 가능한 구성 요소를 포함시킵니다.
빛과 어두운 모드	밝은 테마와 어두운 테마를 전환합니다.
검색 기능	내장 검색으로 콘텐츠를 빠르게 찾으십시오.
코드 스위처	코드 언어 또는 변형 사이를 전환합니다.
코드 사본	한 번의 클릭으로 코드 블록을 복사하십시오.
TOC 옵저버 하이라이트	스크롤 할 때 TOC의 활성 섹션을 강조 표시하십시오.
정적 사이트 생성	정적 고성능 사이트를 생성하십시오.
서구 최적화	최적의 검색 엔진 인덱싱을위한 구조.

추가 테마