문서 작성 가이드

1분 미만

팁

이 문서의 목적은 문서 작성자가 주제가 제공하는 기능을 더 잘 활용하여 더 읽기 쉬운 효과를 얻는 데 도움을 주는 것입니다.

우리의 문서는 vuepress로 작성되었으며, vuepress-theme-hope 테마를 사용하고 있습니다. 더 자세한 설명은 공식 문서를 참조할 수 있으며, 여기서는 일부 일반적인 기능에 대해서만 소개하겠습니다.

로컬 배포

~~도커 컨테이너가 아닙니다~~

이 테마는 팁, 주석, 정보, 주의, 경고 및 세부 정보를 사용자 정의하는 컨테이너를 지원합니다. 이 기능을 사용하여 내용을 강조할 수 있습니다.

컨테이너 사용 방법:

::: [컨테이너 타입] [컨테이너 제목(선택사항)]
내용을 입력하세요
:::

허용되는 컨테이너 유형 및 기본 제목은 다음과 같습니다:

팁

이것은 팁 컨테이너입니다.

노트

이것은 주석 컨테이너입니다.

정보

이것은 정보 컨테이너입니다.

경고

이것은 주의 컨테이너입니다.

위험

이것은 위험 컨테이너입니다.

세부사항

이것은 세부 사항 컨테이너입니다.

이 테마는 아이콘을 지원합니다. 다음 위치에서 아이콘을 사용할 수 있습니다:

문서의 frontmatter 에서 icon을 사용하여 문서의 아이콘을 설정할 수 있습니다.

이 아이콘은 문서 제목 옆에 표시됩니다.

이 문서의 frontmatter 설정

---
icon: jam:write-f
---

마크다운에서 <HopeIcon /> 구성 요소를 사용하여 아이콘을 추가할 수 있습니다. 이 구성 요소에는 다음과 같은 속성이 있습니다:

예시

<HopeIcon icon="ic:round-home" color="#1f1e33"/>

<HopeIcon icon="/image/maa-logo_512x512.png" size="4rem" />

이 문서에서 사용하는 아이콘은 iconify에서 제공됩니다. 원하는 아이콘을 검색하려면 제공된 아이콘 검색 페이지에서 검색한 다음 키워드를 복사하세요.

Frontmatter는 Markdown 문서의 시작 부분에 ---로 둘러싸인 내용이며 내부에서는 YAML 구문을 사용합니다. Frontmatter를 통해 문서의 편집 시간, 사용된 아이콘, 분류, 태그 등을 식별할 수 있습니다.

예시

---
date: 1919-08-10
icon: jam:write-f
order: 1
---

# 문서 제목

...

각 필드의 의미는 다음과 같습니다: