Plugin Options

Less than 1 minute

Options

componentsAvailableComponent[]

Default[]

Components to be registered.

Available component names:

"Badge"
"CodePen"
"Share"
"StackBlitz"
"SiteInfo"
"VPBanner"
"VPCard"

Tips

The media components are moved to @vuepress/plugin-media.

componentsOptionsComponentGlobalOptions

Global config for components.

ShareOptions

Share config.

Required(string | ShareService)[]

Share services.

string

Twitter username.

localesComponentLocaleOptions

Component locales.

locales.siteInfoSiteInfoLocaleConfig

Locales config for site info component.

locales.siteInfo.<localePath>.sourcestring

Source text.

Changelog

9/28/26, 12:45 PM

View All Changelog

0c1aa-docs: migrate option docs to fields container (#5425)on 9/28/26
4ea6d-feat: use media plugin for media components (#5419)on 9/24/26
b331c-feat(components)!: remove repliton 4/30/25
5a8ce-feat(components)!: remove xigua (#4848)on 4/14/25
dd4a8-fix(theme): fix icon plugin supporton 2/10/25
ea175-feat: apply guidelineson 9/11/24
71048-feat(theme): support notice (#4118)on 5/8/24
9bd48-feat(components): rebuild vidstack, audio-player and video-playeron 4/7/24
a50a4-feat(components): remove iconfont keywordon 3/28/24
2f66e-fix(components): ensure base is appendedon 2/22/24
05c41-feat: compatible with latest vuepress (#3906)on 2/5/24
8f594-feat: use official back-to-top buttonon 2/3/24
0739c-feat(components): add VPBanner and VPCardon 11/10/23
0f844-docs: update docson 11/10/23
dfc52-feat(components): remove addThison 10/13/23
d3b16-feat(components): support vidstack@v1on 10/10/23
3d75e-docs: fix typoson 8/8/23
c887b-docs: remove VIdStackon 6/8/23
6136a-feat(components): add VidStackon 6/7/23
79d68-feat(components): add progress for backtotopon 4/16/23
42090-fix(components): fix iconAssetson 3/20/23
a7a28-feat: add Dutch language support (#2852)on 3/4/23
12ecd-feat: add Indonesian language support (#2828)on 2/26/23
e08cc-feat(components): add share component (#2783)on 2/16/23
addb6-feat(components): add iconify support, close #2785 (#2786)on 2/15/23
34f79-chore(components): improve styleson 2/13/23
9b72f-feat(components): add Replit component (#2764)on 2/11/23
760c6-feat: catalog component is now inside auto-catalog pluginon 1/28/23
8902d-feat(components): add xiguaon 1/23/23
edf2d-docs: update docson 1/19/23
27c6a-fix(components): fix typos in configon 1/19/23
869de-feat(components): add fontawesome-with-brands keywordon 1/19/23
4104e-docs: use fontawesomeon 1/17/23
3cdac-feat(components): add Artplayer component (#2670)on 1/13/23
1c52f-docs: update i18n docson 1/9/23
15ee5-feat(components): rebuild notice options, support notice per pathon 1/8/23
7cd56-feat(components): support locales in PDFon 1/2/23
20622-feat(components): support locale options for catalogon 12/31/22
aafb1-feat(components): split pdfjs files out of repoon 12/27/22
ae2d2-docs: update docson 12/16/22
69cce-feat(components): add audio playeron 12/8/22
563e2-feat(components): rebuild component optionson 12/8/22
2a9e9-feat(components): remove canClose and add confirm props for Noticeon 11/30/22
d28b6-feat(components): add notice componenton 11/29/22
6639c-docs: update i18n docson 11/19/22
2243a-chore: fix typoson 11/1/22
9fcf5-docs: update docson 10/13/22
84771-docs: update docson 10/12/22
2788c-feat(components): add video playeron 10/5/22
5d62e-feat(components): add Bilibili componenton 10/5/22
01612-docs: correct iconAssets config value (#2092)on 7/28/22
80eb7-docs: improve docson 6/13/22
22c53-feat(components): add YouTube componenton 6/11/22
f732e-feat(components): add StackBlitz componenton 5/25/22
c10f5-docs(theme): update icon docson 5/22/22
b51bf-feat(components): update option nameon 5/22/22
5cc7a-feat: remove add-this pluginon 5/21/22
b34cb-feat(components): remove backToTopThresholdon 5/21/22
48bca-feat(md-enhance): rebuild code tabs and support tabidon 5/21/22
07909-feat(components): add Tab componenton 5/20/22
1e4eb-feat(components): add CodePen and PDF componenton 5/19/22
73de5-docs: update docson 4/15/22
3e855-refactor: move some components back to themeon 4/14/22
716f9-chore: add demoson 3/24/22
92c11-feat(components): update component optionson 3/20/22
8dc9f-chore: fix typos and update docson 2/18/22
2d779-docs: typo fixeson 2/11/22
e7f0c-docs(components): update docson 2/8/22
ba517-refactor(components): rebuild articleInfoon 1/30/22
0cb0b-docs(components): add docson 1/27/22

Contributors

Agis Nuryanto