문서 작성

문서 파일 위치, 머리말 필드, 그룹 구성 방법을 설명합니다.

파일 위치

경로설명
content/docs/index.mdx문서 홈
content/docs/<그룹>/meta.json그룹 제목과 문서 순서
content/docs/<그룹>/<문서>.mdx그룹에 속한 문서

머리말

이름설명필수
title문서 제목O
description제목 아래 리드 문장X
예제: 그룹 정의
content/docs/guide/meta.json
{
  "title": "가이드",
  "pages": ["writing"]
}

확인

  1. 개발 서버를 실행합니다.
  2. /docs/<그룹>/<문서> 주소로 이동합니다.
터미널
npm run dev