Skip to content

Commit 5e12ef7

Browse files
committed
docs: format
1 parent 5b7ccbc commit 5e12ef7

33 files changed

+1628
-1638
lines changed

docs/en/reference/default-theme-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ export default defineConfig({
179179
async _render(src, env, md) {
180180
const html = await md.renderAsync(src, env)
181181
if (env.frontmatter?.title)
182-
return await md.renderAsync(`# ${env.frontmatter.title}`) + html
182+
return (await md.renderAsync(`# ${env.frontmatter.title}`)) + html
183183
return html
184184
}
185185
}

docs/en/reference/runtime-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ interface PageData {
4949
titleTemplate?: string | boolean
5050
description: string
5151
relativePath: string
52-
filePath: string,
52+
filePath: string
5353
headers: Header[]
5454
frontmatter: Record<string, any>
5555
params?: Record<string, any>

docs/es/reference/default-theme-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ export default defineConfig({
174174
async _render(src, env, md) {
175175
const html = await md.renderAsync(src, env)
176176
if (env.frontmatter?.title)
177-
return await md.renderAsync(`# ${env.frontmatter.title}`) + html
177+
return (await md.renderAsync(`# ${env.frontmatter.title}`)) + html
178178
return html
179179
}
180180
}

docs/es/reference/runtime-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ interface PageData {
4545
titleTemplate?: string | boolean
4646
description: string
4747
relativePath: string
48-
filePath: string,
48+
filePath: string
4949
headers: Header[]
5050
frontmatter: Record<string, any>
5151
params?: Record<string, any>

docs/fa/reference/default-theme-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ export default defineConfig({
174174
async _render(src, env, md) {
175175
const html = await md.renderAsync(src, env)
176176
if (env.frontmatter?.title)
177-
return await md.renderAsync(`# ${env.frontmatter.title}`) + html
177+
return (await md.renderAsync(`# ${env.frontmatter.title}`)) + html
178178
return html
179179
}
180180
}

docs/fa/reference/runtime-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ interface PageData {
4949
titleTemplate?: string | boolean
5050
description: string
5151
relativePath: string
52-
filePath: string,
52+
filePath: string
5353
headers: Header[]
5454
frontmatter: Record<string, any>
5555
params?: Record<string, any>

docs/ja/guide/cms.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,44 +12,44 @@ CMS ごとに動作が異なるため、ここでは各自の環境に合わせ
1212

1313
1. CMS が認証を必要とする場合は、API トークンを格納するための `.env` を作成し、次のように読み込みます。
1414

15-
```js
16-
// posts/[id].paths.js
17-
import { loadEnv } from 'vitepress'
15+
```js
16+
// posts/[id].paths.js
17+
import { loadEnv } from 'vitepress'
1818

19-
const env = loadEnv('', process.cwd())
20-
```
19+
const env = loadEnv('', process.cwd())
20+
```
2121

2222
2. CMS から必要なデータを取得し、適切なパスデータの形式に整形します。
2323

24-
```js
25-
export default {
26-
async paths() {
27-
// 必要に応じて各 CMS のクライアントライブラリを使用
28-
const data = await (await fetch('https://my-cms-api', {
29-
headers: {
30-
// 必要ならトークン
31-
}
32-
})).json()
33-
34-
return data.map(entry => {
35-
return {
36-
params: { id: entry.id, /* title, authors, date など */ },
37-
content: entry.content
38-
}
39-
})
40-
}
41-
}
42-
```
24+
```js
25+
export default {
26+
async paths() {
27+
// 必要に応じて各 CMS のクライアントライブラリを使用
28+
const data = await (await fetch('https://my-cms-api', {
29+
headers: {
30+
// 必要ならトークン
31+
}
32+
})).json()
33+
34+
return data.map((entry) => {
35+
return {
36+
params: { id: entry.id, /* title, authors, date など */ },
37+
content: entry.content
38+
}
39+
})
40+
}
41+
}
42+
```
4343

4444
3. ページ内でコンテンツをレンダリングします。
4545

46-
```md
47-
# {{ $params.title }}
46+
```md
47+
# {{ $params.title }}
4848

49-
- {{ $params.date }} に {{ $params.author }} が作成
49+
- {{ $params.date }} に {{ $params.author }} が作成
5050

51-
<!-- @content -->
52-
```
51+
<!-- @content -->
52+
```
5353

5454
## 連携ガイドの募集 {#integration-guides}
5555

docs/ja/guide/custom-theme.md

Lines changed: 37 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -23,43 +23,42 @@ VitePress のカスタムテーマは次のインターフェースを持つオ
2323

2424
```ts
2525
interface Theme {
26-
/**
27-
* すべてのページに適用されるルートレイアウトコンポーネント
28-
* @required
29-
*/
30-
Layout: Component
31-
/**
32-
* Vue アプリインスタンスを拡張
33-
* @optional
34-
*/
35-
enhanceApp?: (ctx: EnhanceAppContext) => Awaitable<void>
36-
/**
37-
* 別のテーマを拡張し、そのテーマの `enhanceApp` を先に実行
38-
* @optional
39-
*/
40-
extends?: Theme
26+
/**
27+
* すべてのページに適用されるルートレイアウトコンポーネント
28+
* @required
29+
*/
30+
Layout: Component
31+
/**
32+
* Vue アプリインスタンスを拡張
33+
* @optional
34+
*/
35+
enhanceApp?: (ctx: EnhanceAppContext) => Awaitable<void>
36+
/**
37+
* 別のテーマを拡張し、そのテーマの `enhanceApp` を先に実行
38+
* @optional
39+
*/
40+
extends?: Theme
4141
}
4242

4343
interface EnhanceAppContext {
44-
app: App // Vue アプリインスタンス
45-
router: Router // VitePress のルーターインスタンス
46-
siteData: Ref<SiteData> // サイト全体のメタデータ
44+
app: App // Vue アプリインスタンス
45+
router: Router // VitePress のルーターインスタンス
46+
siteData: Ref<SiteData> // サイト全体のメタデータ
4747
}
4848
```
4949

5050
テーマエントリファイルでは、このテーマをデフォルトエクスポートとして公開します。
5151

5252
```js [.vitepress/theme/index.js]
53-
5453
// テーマエントリでは Vue ファイルを直接インポートできます
5554
// VitePress は @vitejs/plugin-vue をあらかじめ設定済みです
5655
import Layout from './Layout.vue'
5756

5857
export default {
59-
Layout,
60-
enhanceApp({ app, router, siteData }) {
61-
// ...
62-
}
58+
Layout,
59+
enhanceApp({ app, router, siteData }) {
60+
// ...
61+
}
6362
}
6463
```
6564

@@ -73,10 +72,10 @@ enhanceApp({ app, router, siteData }) {
7372

7473
```vue [.vitepress/theme/Layout.vue]
7574
<template>
76-
<h1>Custom Layout!</h1>
75+
<h1>Custom Layout!</h1>
7776
78-
<!-- この部分に markdown コンテンツが描画されます -->
79-
<Content />
77+
<!-- この部分に markdown コンテンツが描画されます -->
78+
<Content />
8079
</template>
8180
```
8281

@@ -100,11 +99,11 @@ const { page } = useData()
10099

101100
[`useData()`](../reference/runtime-api#usedata) ヘルパーを使うと、条件によってレイアウトを切り替えるために必要なすべてのランタイムデータを取得できます。アクセスできるデータのひとつにフロントマターがあります。これを利用すると、ページごとにレイアウトを制御できます。例えば、ユーザーが特別なホームページレイアウトを使いたい場合は以下のように記述します。
102101

103-
```md
102+
```md
104103
---
105104
layout: home
106105
---
107-
```
106+
```
108107

109108
テーマ側を次のように調整します。
110109

@@ -164,7 +163,6 @@ npm パッケージとして配布する場合は、次の手順を踏みます
164163

165164
## カスタムテーマの利用 {#consuming-a-custom-theme}
166165

167-
168166
外部テーマを利用するには、カスタムテーマエントリからインポートして再エクスポートします。
169167

170168
```js [.vitepress/theme/index.js]
@@ -179,10 +177,10 @@ export default Theme
179177
import Theme from 'awesome-vitepress-theme'
180178

181179
export default {
182-
extends: Theme,
183-
enhanceApp(ctx) {
184-
// ...
185-
}
180+
extends: Theme,
181+
enhanceApp(ctx) {
182+
// ...
183+
}
186184
}
187185
```
188186

@@ -192,8 +190,8 @@ enhanceApp(ctx) {
192190
import baseConfig from 'awesome-vitepress-theme/config'
193191

194192
export default {
195-
// 必要に応じてテーマの基本設定を拡張
196-
extends: baseConfig
193+
// 必要に応じてテーマの基本設定を拡張
194+
extends: baseConfig
197195
}
198196
```
199197

@@ -205,9 +203,9 @@ import { defineConfigWithTheme } from 'vitepress'
205203
import type { ThemeConfig } from 'awesome-vitepress-theme'
206204

207205
export default defineConfigWithTheme<ThemeConfig>({
208-
extends: baseConfig,
209-
themeConfig: {
210-
// 型は `ThemeConfig`
211-
}
206+
extends: baseConfig,
207+
themeConfig: {
208+
// 型は `ThemeConfig`
209+
}
212210
})
213211
```

docs/ja/guide/data-loading.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ VitePress には **データローダー (data loaders)** という機能があ
1010

1111
```js [example.data.js]
1212
export default {
13-
load() {
14-
return {
15-
hello: 'world'
13+
load() {
14+
return {
15+
hello: 'world'
16+
}
1617
}
1718
}
18-
}
1919
```
2020

2121
ローダーモジュールは Node.js 上でのみ評価されるため、Node API や npm 依存関係を自由に利用できます。
@@ -179,7 +179,6 @@ interface ContentOptions<T = ContentData[]> {
179179

180180
## 型付きデータローダー {#typed-data-loaders}
181181

182-
183182
TypeScript を使用する場合は、ローダーと `data` エクスポートを型付けできます。
184183

185184
```ts
@@ -202,7 +201,6 @@ export default defineLoader({
202201

203202
## 設定情報の取得 {#configuration}
204203

205-
206204
ローダー内で設定情報を取得するには次のようにします。
207205

208206
```ts

0 commit comments

Comments
 (0)