vuepress-plugin-vue-example
GitHub
GitHub
  • Introduction
  • Installation and Usage
  • Options

Config

componentsDir

  • Type: string
  • Default: null

The folder in which all the example .vue components are stored.
Either an absolute path or a relative path to the .vuepress directory can be used.
It may contain sub-folders for better organization.

Props

PropDescriptionTypeDefaultRequired
componentThe component name of the example component without the .vue extensionStringEmptyfalse
titleCustom title for the exampleStringExamplefalse
stripCommentsControls whether comments should be removed from the example's codeBooleantruefalse
showLabelsControls whether to show labels on the sections' tabsBooleantruefalse
showIconsControls whether to show icons on the sections' tabsBooleantruefalse
showLoaderControls whether to show a loader spinner while the example component is loadingBooleanfalsefalse
startExpandedControls whether the main section should be expanded upon initializationBooleantruefalse

Slots

default

The default slot to use for adding content inside the live example section.

template

The slot to use for adding content inside the template section.

script

The slot to use for adding content inside the script section.

style

The slot to use for adding content inside the style section.

Edit this page
Last Updated:
Prev
Installation and Usage