VitePress는 내장된 마크다운 확장 기능을 제공합니다.
헤더에는 자동으로 앵커 링크가 적용됩니다. 앵커 렌더링은 markdown.anchor 옵션을 사용하여 구성할 수 있습니다.
자동 생성된 앵커 대신 커스텀 앵커 태그를 지정하려면 헤딩에 접미사를 추가하세요:
# Using custom anchors {#my-anchor}이를 통해 기본값인 #using-custom-anchors 대신 #my-anchor로 헤딩에 링크할 수 있습니다.
내부 링크와 외부 링크 모두 특별하게 취급됩니다.
내부 링크는 SPA 탐색을 위한 라우터 링크로 변환됩니다. 또한 각 하위 디렉터리에 포함된 모든 index.md는 자동으로 index.html로 변환되며, 해당 URL은 /로 설정됩니다.
예를 들어, 다음과 같은 디렉터리 구조가 주어진 경우:
.
├─ index.md
├─ foo
│ ├─ index.md
│ ├─ one.md
│ └─ two.md
└─ bar
├─ index.md
├─ three.md
└─ four.md그리고 현재 foo/one.md에 있다고 가정하면:
[Home](/) <!-- 사용자를 루트 index.md로 보냅니다 -->
[foo](/foo/) <!-- foo 디렉토리의 index.html로 보냅니다 -->
[foo heading](./#heading) <!-- foo index 파일의 헤딩으로 앵커링합니다 -->
[bar - three](../bar/three) <!-- 확장자를 생략할 수 있습니다 -->
[bar - three](../bar/three.md) <!-- .md를 추가할 수 있습니다 -->
[bar - four](../bar/four.html) <!-- 또는 .html을 추가할 수 있습니다 -->페이지와 내부 링크는 기본적으로 .html 접미사와 함께 생성됩니다.
외부 링크는 자동으로 target="_blank" rel="noreferrer"를 갖습니다.
YAML 전문이 기본적으로 지원됩니다:
---
title: Blogging Like a Hacker
lang: en-US
---이 데이터는 페이지의 나머지 부분과 모든 커스텀 및 테마 컴포넌트에서 사용할 수 있습니다.
자세한 내용은 전문을 참고하세요.
입력
| Tables | Are | Cool |
| ------------- | :-----------: | ----: |
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |출력
| Tables | Are | Cool |
|---|---|---|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
입력
:tada: :100:출력
🎉 💯
모든 이모지의 목록이 제공됩니다.
입력
[[toc]]출력
목차의 렌더링은 markdown.toc 옵션을 사용하여 구성할 수 있습니다.
커스텀 컨테이너는 타입, 제목, 콘텐츠를 정의할 수 있습니다.
입력
::: info
정보 상자입니다.
:::
::: tip
팁입니다.
:::
::: warning
경고입니다.
:::
::: danger
위험한 경고입니다.
:::
::: details
세부 정보 블록입니다.
:::출력
INFO
정보 상자입니다.
TIP
팁입니다.
WARNING
경고입니다.
DANGER
위험한 경고입니다.
세부 정보 블록입니다.
컨테이너의 "타입" 바로 뒤에 텍스트를 추가하여 커스텀 제목을 설정할 수 있습니다.
입력
::: danger 정지
위험 지대, 진행하지 마세요
:::
::: details 코드를 보려면 클릭하세요
\`\`\`js
console.log('Hello, VitePress!')
\`\`\`
:::출력
정지
위험 지대, 진행하지 마세요
console.log('Hello, VitePress!')또는 사이트 구성에 다음을 추가하여 커스텀 제목을 전역적으로 설정할 수 있습니다. 이는 제목을 영어로 작성하지 않을 경우 유용합니다:
// config.ts
export default defineConfig({
// ...
markdown: {
container: {
tipLabel: '팁',
warningLabel: '경고',
dangerLabel: '위험',
infoLabel: '정보',
detailsLabel: '세부 정보'
}
}
// ...
})raw 이것은 VitePress와 스타일 및 라우터 충돌을 방지하기 위해 사용할 수 있는 특별한 컨테이너입니다. 컴포넌트 라이브러리를 문서화할 때 특히 유용합니다. 더 나은 분리를 위해 whyframe을 참고해 볼 수 있습니다.
문법
::: raw
<div class="vp-raw">로 감쌉니다
:::vp-raw 클래스는 엘리먼트에 직접 사용할 수도 있습니다. 스타일 분리는 현재 선택 사항입니다:
선호하는 패키지 매니저를 사용하여 postcss를 설치하세요:
$ npm add -D postcssdocs/postcss.config.mjs라는 파일을 만들고 다음 내용을 추가하세요:
import { postcssIsolateStyles } from 'vitepress'
export default {
plugins: [postcssIsolateStyles()]
}이것은 기본적으로 postcss-prefix-selector를 사용합니다. 다음과 같이 옵션을 전달할 수 있습니다:
postcssIsolateStyles({
includeFiles: [/vp-doc\\.css/] // 기본값은 /base\\.css/
})VitePress는 GitHub 스타일 알림을 콜아웃으로 렌더링하는 것을 지원합니다. 이것은 커스텀 컨테이너와 같은 방식으로 렌더링됩니다.
> [!NOTE]
> 문서를 빠르게 탐색할 때에도 사용자가 놓치지 말아야 할 중요한 정보.
> [!TIP]
> 사용자가 보다 원활하게 목표를 달성하는 데 도움이 되는 정보
> [!IMPORTANT]
> 사용자가 목표를 달성하는 데 중요한 정보.
> [!WARNING]
> 위험 가능성 때문에 사용자의 즉각적인 주의가 필요한 중요한 정보.
> [!CAUTION]
> 실행할 경우 잠재적으로 부정적인 결과를 생성한다는 것을 알리는 정보.NOTE
문서를 빠르게 탐색할 때에도 사용자가 놓치지 말아야 할 중요한 정보.
TIP
사용자가 보다 원활하게 목표를 달성하는 데 도움이 되는 정보
IMPORTANT
사용자가 목표를 달성하는 데 중요한 정보.
WARNING
위험 가능성 때문에 사용자의 즉각적인 주의가 필요한 중요한 정보.
CAUTION
실행할 경우 잠재적으로 부정적인 결과를 생성한다는 것을 알리는 정보.
VitePress는 마크다운 코드 블록 내 언어 문법을 색상이 있는 텍스트로 강조하기 위해 Shiki를 사용합니다. Shiki는 다양한 프로그래밍 언어를 지원합니다. 코드 블록의 시작 백틱에 유효한 언어 별칭을 추가하기만 하면 됩니다:
입력
\`\`\`js
export default {
name: 'MyComponent',
// ...
}
\`\`\`\`\`\`html
<ul>
<li v-for="todo in todos" :key="todo.id">
{{ todo.text }}
</li>
</ul>
\`\`\`출력
export default {
name: 'MyComponent',
// ...
}<ul>
<li v-for="todo in todos" :key="todo.id">
{{ todo.text }}
</li>
</ul>Shiki의 리포지터리에서 사용 가능한 유효한 언어 목록이 제공됩니다.
또한 애플리케이션 구성에서 구문 강조 테마를 커스텀 할 수 있습니다. 자세한 내용은 markdown 옵션을 참고하세요.
입력
\`\`\`js{4}
export default {
data () {
return {
msg: '강조됨!'
}
}
}
\`\`\`출력
export default {
data() {
return {
msg: '강조됨!'
}
}
}단일 라인 뿐만 아니라 여러 개의 단일 라인, 범위 또는 둘 다 지정할 수도 있습니다:
{5-8}, {3-10}, {10-17}{4,7,9}{4,7-13,16,23-27,40}입력
\`\`\`js{1,4,6-8}
export default { // 강조됨
data () {
return {
msg: \`강조됨!
이 줄은 강조되지 않습니다,
하지만 이 줄과 다음 2줄은 강조됩니다.\`,
motd: 'VitePress는 멋져요',
lorem: 'ipsum'
}
}
}
\`\`\`출력
export default { // 강조됨
data () {
return {
msg: \`강조됨!
이 줄은 강조되지 않습니다,
하지만 이 줄과 다음 2줄은 강조됩니다.\`,
motd: 'VitePress는 멋져요',
lorem: 'ipsum',
}
}
}또는 // [!code highlight] 주석을 사용하여 직접 라인에 강조를 추가할 수 있습니다.
입력
\`\`\`js
export default {
data () {
return {
msg: '강조됨!' // [!code highlight]
}
}
}
\`\`\`출력
export default {
data () {
return {
msg: '강조됨!'
}
}
}// [!code focus] 주석을 라인에 추가하면 해당 라인이 포커싱되고 코드의 다른 부분은 흐릿하게 처리됩니다.
추가로 // [!code focus:<lines>]를 사용하여 포커싱할 라인 수를 정의할 수 있습니다.
입력
\`\`\`js
export default {
data () {
return {
msg: '포커싱됨!' // [!code focus]
}
}
}
\`\`\`출력
export default {
data () {
return {
msg: '포커싱됨!'
}
}
}// [!code --] 또는 // [!code ++] 주석을 라인에 추가하면 해당 라인의 차이점을 나타내며, 코드 블록의 색상을 유지합니다.
입력
\`\`\`js
export default {
data () {
return {
msg: '삭제됨' // [!code --]
msg: '추가됨' // [!code ++]
}
}
}
\`\`\`출력
export default {
data () {
return {
msg: '삭제됨'
msg: '추가됨'
}
}
}// [!code warning] 또는 // [!code error] 주석을 라인에 추가하면 해당 라인이 색칠됩니다.
입력
\`\`\`js
export default {
data () {
return {
msg: '오류', // [!code error]
msg: '경고' // [!code warning]
}
}
}
\`\`\`출력
export default {
data () {
return {
msg: '오류',
msg: '경고'
}
}
}구성을 통해 각 코드 블록에 라인 번호를 활성화할 수 있습니다:
export default {
markdown: {
lineNumbers: true
}
}자세한 내용은 markdown 옵션을 참고하세요.
구성에서 지정한 값을 무시하려면 펜싱 코드 블록에 :line-numbers / :no-line-numbers 마크를 추가하면 됩니다.
또한 =를 :line-numbers 뒤에 추가하여 시작 라인 번호를 커스텀 할 수도 있습니다. 예를 들어 :line-numbers=2는 코드 블록의 라인 번호가 2부터 시작함을 의미합니다.
입력
\`\`\`ts {1}
// 줄 번호는 기본적으로 비활성화되어 있음
const line2 = 'This is line 2'
const line3 = 'This is line 3'
\`\`\`
\`\`\`ts:line-numbers {1}
// 줄 번호가 활성화됨
const line2 = 'This is line 2'
const line3 = 'This is line 3'
\`\`\`
\`\`\`ts:line-numbers=2 {1}
// 줄 번호가 활성화되고 2부터 시작함
const line3 = 'This is line 3'
const line4 = 'This is line 4'
\`\`\`출력
// 줄 번호는 기본적으로 비활성화되어 있음
const line2 = 'This is line 2'
const line3 = 'This is line 3'// 줄 번호가 활성화됨
const line2 = 'This is line 2'
const line3 = 'This is line 3'// 줄 번호가 활성화되고 2부터 시작함
const line3 = 'This is line 3'
const line4 = 'This is line 4'다음 문법을 통해 기존 파일에서 코드 스니펫을 가져올 수 있습니다:
<<< @/파일경로다음과 같이 라인 강조도 지원합니다:
<<< @/파일경로{강조 할 라인}입력
<<< @/snippets/snippet.js{2}코드 파일
export default function () {
// ..
}출력
export default function () {
// ..
}TIP
@의 값은 소스 루트에 해당합니다. 기본값은 VitePress 프로젝트 루트이지만, srcDir이 구성되어 있을 경우에는 다릅니다. 상대 경로에서도 가져올 수도 있습니다:
<<< ../snippets/snippet.js특정 부분의 코드 파일만 포함하려면 VS Code 리전을 사용할 수 있습니다. 파일 경로 뒤에 #을 사용한 다음 커스텀 리전 이름을 제공할 수 있습니다:
입력
<<< @/snippets/snippet-with-region.js#snippet{1}코드 파일
// #region snippet
function foo() {
// ..
}
// #endregion snippet
export default foo출력
function foo() {
// ..
}괄호({}) 안에 언어를 지정할 수도 있습니다:
<<< @/snippets/snippet.cs{c#}
<!-- 라인 강조와 함께: -->
<<< @/snippets/snippet.cs{1,2,4-6 c#}
<!-- 라인 번호와 함께: -->
<<< @/snippets/snippet.cs{1,2,4-6 c#:line-numbers}이는 파일 확장명에서 소스 언어를 유추할 수 없을 때 유용합니다.
다음과 같이 여러 코드 블록을 그룹화할 수 있습니다:
입력
::: code-group
\`\`\`js [config.js]
/**
* @type {import('vitepress').UserConfig}
*/
const config = {
// ...
}
export default config
\`\`\`
\`\`\`ts [config.ts]
import type { UserConfig } from 'vitepress'
const config: UserConfig = {
// ...
}
export default config
\`\`\`
:::출력
/**
* @type {import('vitepress').UserConfig}
*/
const config = {
// ...
}
export default configimport type { UserConfig } from 'vitepress'
const config: UserConfig = {
// ...
}
export default config코드 그룹에서 스니펫 가져오기도 할 수 있습니다:
입력
::: code-group
<!-- 기본적으로 파일 이름이 제목으로 사용됩니다 -->
<<< @/snippets/snippet.js
<!-- 커스텀 제목도 제공할 수 있습니다 -->
<<< @/snippets/snippet-with-region.js#snippet{1,2 ts:line-numbers} [지역 스니펫]
:::출력
export default function () {
// ..
}function foo() {
// ..
}마크다운 파일을 다른 마크다운 파일에 포함시킬 수 있으며, 중첩도 가능합니다.
TIP
마크다운 경로 앞에 @를 붙일 수도 있으며, 이는 소스 루트로 작동합니다. 기본적으로 이는 VitePress 프로젝트 루트이며, srcDir이 구성되지 않은 경우입니다.
다음과 같이 상대적인 마크다운 파일을 포함시킬 수 있습니다:
입력
# Docs
## Basics
<!--@include: ./parts/basics.md-->해당 파일 (parts/basics.md)
Some getting started stuff.
### Configuration
Can be created using \`.foorc.json\`.동일한 코드
# Docs
## Basics
Some getting started stuff.
### Configuration
Can be created using \`.foorc.json\`.라인 범위 선택도 지원합니다:
입력
# Docs
## Basics
<!--@include: ./parts/basics.md{3,}-->해당 파일 (parts/basics.md)
Some getting started stuff.
### Configuration
Can be created using \`.foorc.json\`.동일한 코드
# Docs
## Basics
### Configuration
Can be created using \`.foorc.json\`.선택된 라인 범위의 형식은 {3,}, {,10}, {1,10}이 될 수 있습니다.
VS Code 리전을 사용하여 코드 파일의 해당 부분만 포함할 수도 있습니다. 파일 경로 뒤에 #를 붙이고 커스텀 영역 이름을 제공할 수 있습니다:
입력
# Docs
## Basics
<!--@include: ./parts/basics.md#basic-usage{,2}-->
<!--@include: ./parts/basics.md#basic-usage{5,}-->해당 파일 (parts/basics.md)
<!-- #region basic-usage -->
## Usage Line 1
## Usage Line 2
## Usage Line 3
<!-- #endregion basic-usage -->동일한 코드
# Docs
## Basics
## Usage Line 1
## Usage Line 3WARNING
파일이 존재하지 않더라도 오류가 발생하지 않는다는 점에 유의하십시오. 따라서 이 기능을 사용할 때 내용이 예상대로 렌더링되고 있는지 확인해야 합니다.
선택 사항입니다. 활성화하려면 markdown-it-mathjax3를 설치하고 설정 파일에서 markdown.math를 true로 설정해야 합니다:
npm add -D markdown-it-mathjax3export default {
markdown: {
math: true
}
}입력
$a \\ne 0$ 일 때, $(ax^2 + bx + c = 0)$의 두 해는 다음과 같습니다:
$$ x = {-b \\pm \\sqrt{b^2-4ac} \\over 2a} $$
**맥스웰 방정식:**
| 방정식 | 설명 |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| $\\nabla \\cdot \\vec{\\mathbf{B}} = 0$ | $\\vec{\\mathbf{B}}$의 발산은 0입니다 |
| $\\nabla \\times \\vec{\\mathbf{E}}\\, +\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{B}}}{\\partial t} = \\vec{\\mathbf{0}}$ | $\\vec{\\mathbf{E}}$의 회전은 $\\vec{\\mathbf{B}}$의 시간에 따른 변화율에 비례합니다 |
| $\\nabla \\times \\vec{\\mathbf{B}} -\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{E}}}{\\partial t} = \\frac{4\\pi}{c}\\vec{\\mathbf{j}} \\nabla \\cdot \\vec{\\mathbf{E}} = 4 \\pi \\rho$ | _wha?_ |출력
`,200)),s("p",null,[s("mjx-container",h,[(t(),n("svg",d,a[0]||(a[0]=[i('마크다운을 통해 추가된 각 이미지에 대해 지연 로딩을 활성화하려면 구성 파일에서 lazyLoading을 true로 설정하세요:
export default {
markdown: {
image: {
// 이미지 지연 로딩은 기본적으로 비활성화 되어 있습니다
lazyLoading: true
}
}
}VitePress는 마크다운 렌더러로 markdown-it을 사용합니다. 위의 많은 확장 기능은 커스텀 플러그인을 통해 구현됩니다. .vitepress/config.js의 markdown 옵션을 사용하여 markdown-it 인스턴스를 추가로 커스터마이즈할 수 있습니다:
import { defineConfig } from 'vitepress'
import markdownItAnchor from 'markdown-it-anchor'
import markdownItFoo from 'markdown-it-foo'
export default defineConfig({
markdown: {
// markdown-it-anchor의 옵션
// https://github.com/valeriangalliat/markdown-it-anchor#usage
anchor: {
permalink: markdownItAnchor.permalink.headerLink()
},
// @mdit-vue/plugin-toc의 옵션
// https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc#options
toc: { level: [1, 2] },
config: (md) => {
// 더 많은 markdown-it 플러그인을 사용!
md.use(markdownItFoo)
}
}
})구성 가능한 프로퍼티의 전체 목록은 레퍼런스: 앱 구성에서 확인하세요.
`,7))])}const j=e(p,[["render",D]]);export{L as __pageData,j as default};