Skip to content

Commit 202b311

Browse files
committed
consistent heading styles for API docs (baesd on vuejs#1995)
1 parent 47b61fc commit 202b311

19 files changed

+106
-106
lines changed

src/api/application.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Creates an application instance.
3535
const app = createApp(App)
3636
```
3737

38-
- **See also:** [Guide - Creating a Vue Application](/guide/essentials/application)
38+
- **See also** [Guide - Creating a Vue Application](/guide/essentials/application)
3939

4040
## createSSRApp() {#createssrapp}
4141

@@ -119,7 +119,7 @@ Registers a global component if passing both a name string and a component defin
119119
const MyComponent = app.component('my-component')
120120
```
121121

122-
- **See also:** [Component Registration](/guide/components/registration)
122+
- **See also** [Component Registration](/guide/components/registration)
123123

124124
## app.directive() {#app-directive}
125125

@@ -157,7 +157,7 @@ Registers a global custom directive if passing both a name string and a directiv
157157
const myDirective = app.directive('my-directive')
158158
```
159159

160-
- **See also:** [Custom Directives](/guide/reusability/custom-directives)
160+
- **See also** [Custom Directives](/guide/reusability/custom-directives)
161161

162162
## app.use() {#app-use}
163163

@@ -192,7 +192,7 @@ Installs a [plugin](/guide/reusability/plugins).
192192
app.use(MyPlugin)
193193
```
194194

195-
- **See also:** [Plugins](/guide/reusability/plugins)
195+
- **See also** [Plugins](/guide/reusability/plugins)
196196

197197
## app.mixin() {#app-mixin}
198198

@@ -266,7 +266,7 @@ Provide a value that can be injected in all descendant components within the app
266266

267267
</div>
268268

269-
- **See also:**
269+
- **See also**
270270
- [Provide / Inject](/guide/components/provide-inject)
271271
- [App-level Provide](/guide/components/provide-inject#app-level-provide)
272272
- [app.runWithContext()](#app-runwithcontext)
@@ -328,7 +328,7 @@ Provides the version of Vue that the application was created with. This is usefu
328328
}
329329
```
330330

331-
- **See also:** [Global API - version](/api/general#version)
331+
- **See also** [Global API - version](/api/general#version)
332332

333333
## app.config {#app-config}
334334

@@ -420,9 +420,9 @@ Assign a custom handler for runtime warnings from Vue.
420420

421421
Set this to `true` to enable component init, compile, render and patch performance tracing in the browser devtool performance/timeline panel. Only works in development mode and in browsers that support the [performance.mark](https://developer.mozilla.org/en-US/docs/Web/API/Performance/mark) API.
422422

423-
- **Type**: `boolean`
423+
- **Type:** `boolean`
424424

425-
- **See also:** [Guide - Performance](/guide/best-practices/performance)
425+
- **See also** [Guide - Performance](/guide/best-practices/performance)
426426

427427
## app.config.compilerOptions {#app-config-compileroptions}
428428

@@ -457,7 +457,7 @@ Specifies a check method to recognize native custom elements.
457457
}
458458
```
459459

460-
- **See also:** [Vue and Web Components](/guide/extras/web-components)
460+
- **See also** [Vue and Web Components](/guide/extras/web-components)
461461

462462
### app.config.compilerOptions.whitespace {#app-config-compileroptions-whitespace}
463463

@@ -554,7 +554,7 @@ An object that can be used to register global properties that can be accessed on
554554
}
555555
```
556556

557-
- **See also:** [Guide - Augmenting Global Properties](/guide/typescript/options-api#augmenting-global-properties) <sup class="vt-badge ts" />
557+
- **See also** [Guide - Augmenting Global Properties](/guide/typescript/options-api#augmenting-global-properties) <sup class="vt-badge ts" />
558558

559559
## app.config.optionMergeStrategies {#app-config-optionmergestrategies}
560560

@@ -605,4 +605,4 @@ An object for defining merging strategies for custom component options.
605605
// logs 'Hello Vue'
606606
```
607607
608-
- **See also:** [Component Instance - `$options`](/api/component-instance#options)
608+
- **See also** [Component Instance - `$options`](/api/component-instance#options)

src/api/built-in-components.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Provides animated transition effects to a **single** element or component.
103103
```
104104

105105
Forcing a transition by changing the `key` attribute:
106-
106+
107107
```vue-html
108108
<Transition>
109109
<div :key="text">{{ text }}</div>
@@ -126,7 +126,7 @@ Provides animated transition effects to a **single** element or component.
126126
</Transition>
127127
```
128128

129-
- **See also:** [`<Transition>` Guide](/guide/built-ins/transition)
129+
- **See also** [`<Transition>` Guide](/guide/built-ins/transition)
130130

131131
## `<TransitionGroup>` {#transitiongroup}
132132

@@ -172,7 +172,7 @@ Provides transition effects for **multiple** elements or components in a list.
172172
</TransitionGroup>
173173
```
174174

175-
- **See also:** [Guide - TransitionGroup](/guide/built-ins/transition-group)
175+
- **See also** [Guide - TransitionGroup](/guide/built-ins/transition-group)
176176

177177
## `<KeepAlive>` {#keepalive}
178178

@@ -265,7 +265,7 @@ Caches dynamically toggled components wrapped inside.
265265
</KeepAlive>
266266
```
267267

268-
- **See also:** [Guide - KeepAlive](/guide/built-ins/keep-alive)
268+
- **See also** [Guide - KeepAlive](/guide/built-ins/keep-alive)
269269

270270
## `<Teleport>` {#teleport}
271271

@@ -307,7 +307,7 @@ Renders its slot content to another part of the DOM.
307307
</teleport>
308308
```
309309

310-
- **See also:** [Guide - Teleport](/guide/built-ins/teleport)
310+
- **See also** [Guide - Teleport](/guide/built-ins/teleport)
311311

312312
## `<Suspense>` <sup class="vt-badge experimental" /> {#suspense}
313313

@@ -333,4 +333,4 @@ Used for orchestrating nested async dependencies in a component tree.
333333

334334
If it encounters async dependencies ([Async Components](/guide/components/async) and components with [`async setup()`](/guide/built-ins/suspense#async-setup)) while rendering the default slot, it will wait until all of them are resolved before displaying the default slot.
335335

336-
- **See also:** [Guide - Suspense](/guide/built-ins/suspense)
336+
- **See also** [Guide - Suspense](/guide/built-ins/suspense)

src/api/built-in-directives.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ Update the element's text content.
1818
<span>{{msg}}</span>
1919
```
2020

21-
- **See also:** [Template Syntax - Text Interpolation](/guide/essentials/template-syntax#text-interpolation)
21+
- **See also** [Template Syntax - Text Interpolation](/guide/essentials/template-syntax#text-interpolation)
2222

2323
## v-html {#v-html}
2424

2525
Update the element's [innerHTML](https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML).
2626

2727
- **Expects:** `string`
2828

29-
- **Details:**
29+
- **Details**
3030

3131
Contents of `v-html` are inserted as plain HTML - Vue template syntax will not be processed. If you find yourself trying to compose templates using `v-html`, try to rethink the solution by using components instead.
3232

@@ -36,13 +36,13 @@ Update the element's [innerHTML](https://developer.mozilla.org/en-US/docs/Web/AP
3636

3737
In [Single-File Components](/guide/scaling-up/sfc), `scoped` styles will not apply to content inside `v-html`, because that HTML is not processed by Vue's template compiler. If you want to target `v-html` content with scoped CSS, you can instead use [CSS modules](./sfc-css-features#css-modules) or an additional, global `<style>` element with a manual scoping strategy such as BEM.
3838

39-
- **Example:**
39+
- **Example**
4040

4141
```vue-html
4242
<div v-html="html"></div>
4343
```
4444

45-
- **See also:** [Template Syntax - Raw HTML](/guide/essentials/template-syntax#raw-html)
45+
- **See also** [Template Syntax - Raw HTML](/guide/essentials/template-syntax#raw-html)
4646

4747
## v-show {#v-show}
4848

@@ -54,7 +54,7 @@ Toggle the element's visibility based on the truthy-ness of the expression value
5454

5555
`v-show` works by setting the `display` CSS property via inline styles, and will try to respect the initial `display` value when the element is visible. It also triggers transitions when its condition changes.
5656

57-
- **See also:** [Conditional Rendering - v-show](/guide/essentials/conditional#v-show)
57+
- **See also** [Conditional Rendering - v-show](/guide/essentials/conditional#v-show)
5858

5959
## v-if {#v-if}
6060

@@ -72,7 +72,7 @@ Conditionally render an element or a template fragment based on the truthy-ness
7272

7373
When used together, `v-if` has a higher priority than `v-for`. We don't recommend using these two directives together on one element — see the [list rendering guide](/guide/essentials/list#v-for-with-v-if) for details.
7474

75-
- **See also:** [Conditional Rendering - v-if](/guide/essentials/conditional#v-if)
75+
- **See also** [Conditional Rendering - v-if](/guide/essentials/conditional#v-if)
7676

7777
## v-else {#v-else}
7878

@@ -97,7 +97,7 @@ Denote the "else block" for `v-if` or a `v-if` / `v-else-if` chain.
9797
</div>
9898
```
9999

100-
- **See also:** [Conditional Rendering - v-else](/guide/essentials/conditional#v-else)
100+
- **See also** [Conditional Rendering - v-else](/guide/essentials/conditional#v-else)
101101

102102
## v-else-if {#v-else-if}
103103

@@ -128,7 +128,7 @@ Denote the "else if block" for `v-if`. Can be chained.
128128
</div>
129129
```
130130

131-
- **See also:** [Conditional Rendering - v-else-if](/guide/essentials/conditional#v-else-if)
131+
- **See also** [Conditional Rendering - v-else-if](/guide/essentials/conditional#v-else-if)
132132

133133
## v-for {#v-for}
134134

@@ -164,7 +164,7 @@ Render the element or template block multiple times based on the source data.
164164

165165
`v-for` can also work on values that implement the [Iterable Protocol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol), including native `Map` and `Set`.
166166

167-
- **See also:**
167+
- **See also**
168168
- [List Rendering](/guide/essentials/list)
169169

170170
## v-on {#v-on}
@@ -177,7 +177,7 @@ Attach an event listener to the element.
177177

178178
- **Argument:** `event` (optional if using Object syntax)
179179

180-
- **Modifiers:**
180+
- **Modifiers**
181181

182182
- `.stop` - call `event.stopPropagation()`.
183183
- `.prevent` - call `event.preventDefault()`.
@@ -200,7 +200,7 @@ Attach an event listener to the element.
200200

201201
`v-on` also supports binding to an object of event / listener pairs without an argument. Note when using the object syntax, it does not support any modifiers.
202202

203-
- **Example:**
203+
- **Example**
204204

205205
```vue-html
206206
<!-- method handler -->
@@ -249,7 +249,7 @@ Attach an event listener to the element.
249249
<MyComponent @my-event="handleThis(123, $event)" />
250250
```
251251

252-
- **See also:**
252+
- **See also**
253253
- [Event Handling](/guide/essentials/event-handling)
254254
- [Components - Custom Events](/guide/essentials/component-basics#listening-to-events)
255255

@@ -263,13 +263,13 @@ Dynamically bind one or more attributes, or a component prop to an expression.
263263

264264
- **Argument:** `attrOrProp (optional)`
265265

266-
- **Modifiers:**
266+
- **Modifiers**
267267

268268
- `.camel` - transform the kebab-case attribute name into camelCase.
269269
- `.prop` - force a binding to be set as a DOM property. <sup class="vt-badge">3.2+</sup>
270270
- `.attr` - force a binding to be set as a DOM attribute. <sup class="vt-badge">3.2+</sup>
271271

272-
- **Usage:**
272+
- **Usage**
273273

274274
When used to bind the `class` or `style` attribute, `v-bind` supports additional value types such as Array or Objects. See linked guide section below for more details.
275275

@@ -279,7 +279,7 @@ Dynamically bind one or more attributes, or a component prop to an expression.
279279

280280
When used without an argument, can be used to bind an object containing attribute name-value pairs.
281281

282-
- **Example:**
282+
- **Example**
283283

284284
```vue-html
285285
<!-- bind an attribute -->
@@ -336,7 +336,7 @@ Dynamically bind one or more attributes, or a component prop to an expression.
336336

337337
`.camel` is not needed if you are using string templates, or pre-compiling the template with a build step.
338338

339-
- **See also:**
339+
- **See also**
340340
- [Class and Style Bindings](/guide/essentials/class-and-style)
341341
- [Components - Prop Passing Details](/guide/components/props#prop-passing-details)
342342

@@ -353,13 +353,13 @@ Create a two-way binding on a form input element or a component.
353353
- `<textarea>`
354354
- components
355355

356-
- **Modifiers:**
356+
- **Modifiers**
357357

358358
- [`.lazy`](/guide/essentials/forms#lazy) - listen to `change` events instead of `input`
359359
- [`.number`](/guide/essentials/forms#number) - cast valid input string to numbers
360360
- [`.trim`](/guide/essentials/forms#trim) - trim input
361361

362-
- **See also:**
362+
- **See also**
363363

364364
- [Form Input Bindings](/guide/essentials/forms)
365365
- [Component Events - Usage with `v-model`](/guide/components/v-model)
@@ -379,7 +379,7 @@ Denote named slots or scoped slots that expect to receive props.
379379
- `<template>`
380380
- [components](/guide/components/slots#scoped-slots) (for a lone default slot with props)
381381

382-
- **Example:**
382+
- **Example**
383383

384384
```vue-html
385385
<!-- Named slots -->
@@ -412,7 +412,7 @@ Denote named slots or scoped slots that expect to receive props.
412412
</Mouse>
413413
```
414414

415-
- **See also:**
415+
- **See also**
416416
- [Components - Slots](/guide/components/slots)
417417

418418
## v-pre {#v-pre}
@@ -425,7 +425,7 @@ Skip compilation for this element and all its children.
425425

426426
Inside the element with `v-pre`, all Vue template syntax will be preserved and rendered as-is. The most common use case of this is displaying raw mustache tags.
427427

428-
- **Example:**
428+
- **Example**
429429

430430
```vue-html
431431
<span v-pre>{{ this will not be compiled }}</span>
@@ -459,7 +459,7 @@ Render the element and component once only, and skip future updates.
459459

460460
Since 3.2, you can also memoize part of the template with invalidation conditions using [`v-memo`](#v-memo).
461461

462-
- **See also:**
462+
- **See also**
463463
- [Data Binding Syntax - interpolations](/guide/essentials/template-syntax#text-interpolation)
464464
- [v-memo](#v-memo)
465465

@@ -500,7 +500,7 @@ Render the element and component once only, and skip future updates.
500500

501501
`v-memo` can also be used on components to manually prevent unwanted updates in certain edge cases where the child component update check has been de-optimized. But again, it is the developer's responsibility to specify correct dependency arrays to avoid skipping necessary updates.
502502

503-
- **See also:**
503+
- **See also**
504504
- [v-once](#v-once)
505505

506506
## v-cloak {#v-cloak}
@@ -517,7 +517,7 @@ Used to hide un-compiled template until it is ready.
517517

518518
`v-cloak` will remain on the element until the associated component instance is mounted. Combined with CSS rules such as `[v-cloak] { display: none }`, it can be used to hide the raw templates until the component is ready.
519519

520-
- **Example:**
520+
- **Example**
521521

522522
```css
523523
[v-cloak] {

src/api/built-in-special-attributes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The `key` special attribute is primarily used as a hint for Vue's virtual DOM al
3535

3636
When `text` changes, the `<span>` will always be replaced instead of patched, so a transition will be triggered.
3737

38-
- **See also:** [Guide - List Rendering - Maintaining State with `key`](/guide/essentials/list#maintaining-state-with-key)
38+
- **See also** [Guide - List Rendering - Maintaining State with `key`](/guide/essentials/list#maintaining-state-with-key)
3939

4040
## ref {#ref}
4141

@@ -80,7 +80,7 @@ Denotes a [template ref](/guide/essentials/template-refs).
8080

8181
`this.$refs` is also non-reactive, therefore you should not attempt to use it in templates for data-binding.
8282

83-
- **See also:**
83+
- **See also**
8484
- [Guide - Template Refs](/guide/essentials/template-refs)
8585
- [Guide - Typing Template Refs](/guide/typescript/composition-api#typing-template-refs) <sup class="vt-badge ts" />
8686
- [Guide - Typing Component Template Refs](/guide/typescript/composition-api#typing-component-template-refs) <sup class="vt-badge ts" />
@@ -103,7 +103,7 @@ Used for binding [dynamic components](/guide/essentials/component-basics#dynamic
103103
</table>
104104
```
105105

106-
- **See also:**
106+
- **See also**
107107

108108
- [Built-in Special Element - `<component>`](/api/built-in-special-elements#component)
109109
- [Dynamic Components](/guide/essentials/component-basics#dynamic-components)

0 commit comments

Comments
 (0)