\r\n```\r\n\r\nAlternatively, use the `desc` defined in the `container` to write Markdown syntax.\r\n\r\n```md\r\n::: demo src=\"../demo.vue\" title=\"Demo block\"\r\n\r\nThis is a `description` that can be written using Markdown.\r\n\r\n:::\r\n```\r\n\r\n### Describe the solution you'd like\r\n\r\nTo address this, I have created the [markdown-it-vitepress-demo](https://github.com/hairyf/markdown-it-vitepress-demo) plugin. I'm not sure if it can be helpful.\r\n\r\n### Describe alternatives you've considered\r\n\r\n_No response_\r\n\r\n### Additional context\r\n\r\n- https://github.com/vuejs/vitepress/issues/987\r\n- https://github.com/vuejs/vitepress/issues/1349\r\n\r\n### Validations\r\n\r\n- [X] Follow our [Code of Conduct](https://vuejs.org/about/coc.html)\r\n- [X] Read the [docs](https://vitepress.dev).\r\n- [X] Read the [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md).\r\n- [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.",[3039],{"name":3026,"color":3027},2432,"feat(demo): built-in markdown plugin provides support for showcasing demo capabilities.","2024-07-17T14:37:26Z","https://github.com/vuejs/vitepress/issues/2432",0.71248996,{"description":3046,"labels":3047,"number":3049,"owner":3029,"repository":3030,"state":3031,"title":3050,"updated_at":3051,"url":3052,"score":3053},"### Is your feature request related to a problem? Please describe.\r\n\r\nsuch as a vue components library site……\r\nA common problem for a documentation page is to show how to use a component, both in code and with demo of live component.\r\n\r\n### Describe the solution you'd like\r\n\r\nlike this [https://github.com/flingyp/vitepress-demo-preview](https://github.com/flingyp/vitepress-demo-preview)\r\n\r\n### Describe alternatives you've considered\r\n\r\n_No response_\r\n\r\n### Additional context\r\n\r\n_No response_\r\n\r\n### Validations\r\n\r\n- [X] Follow our [Code of Conduct](https://vuejs.org/about/coc.html)\r\n- [X] Read the [docs](https://vitepress.dev).\r\n- [X] Read the [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md).\r\n- [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.",[3048],{"name":3026,"color":3027},3270,"Feature request: Vue component source code demo","2024-01-18T18:48:08Z","https://github.com/vuejs/vitepress/issues/3270",0.7342009,{"description":3055,"labels":3056,"number":3060,"owner":3029,"repository":3030,"state":3031,"title":3061,"updated_at":3062,"url":3063,"score":3064},"### Describe the bug\n\nWhen the Badge component is used in a table, if there is too much text content, the Badge will wrap, destroying the overall style layout of the table. \n\n\u003Cimg width=\"707\" alt=\"Image\" src=\"https://github.com/user-attachments/assets/338571df-b823-4b85-810e-1fbfdee3f8b4\" />\n\n### Reproduction\n\nnone\n\n### Expected behavior\n\nThe text inside the Badge component should not wrap and should remain on the same line to avoid disrupting the table layout.\n\n### System Info\n\n```Text\nnone\n```\n\n### Additional context\n\n_No response_\n\n### Validations\n\n- [x] Check if you're on the [latest VitePress version](https://github.com/vuejs/vitepress/releases/latest).\n- [x] Follow our [Code of Conduct](https://vuejs.org/about/coc.html)\n- [x] Read the [docs](https://vitepress.dev).\n- [x] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.",[3057],{"name":3058,"color":3059},"bug: pending triage","e99695",4764,"Badge component unexpectedly breaks line in tables with long text","2025-05-27T08:28:39Z","https://github.com/vuejs/vitepress/issues/4764",0.7349008,{"description":3066,"labels":3067,"number":3068,"owner":3029,"repository":3030,"state":3069,"title":3070,"updated_at":3071,"url":3072,"score":3073},"### Is your feature request related to a problem? Please describe.\n\nWe're using Custom Elements to encapsulate styles from our design system, so it'd be great to be able to tell Vitepress to ignore those tags.\r\n\r\nSuper lightweight example:\r\n\r\n```js\r\nclass ButtonExample extends HTMLElement {\r\n connectedCallback() {\r\n const designSystemCSS = '\u003Clink rel=\"stylesheet\" type=\"text/css\" href=\"designSystemURL\" />'\r\n const target = `\u003Cdiv id=\"app\">\u003C/div>`\r\n this.shadow = this.attachShadow({ mode: 'open' })\r\n this.shadow.innerHTML = designSystemCSS + target\r\n createApp(App) // App defined elsewhere ofc\r\n .mount(this.shadow.querySelector('#app'))\r\n }\r\n}\r\n```\n\n### Describe the solution you'd like\n\nProbably just being able to set `compilerOptions.isCustomElement` somewhere would be good enough?\n\n### Describe alternatives you've considered\n\n_No response_\n\n### Additional context\n\n_No response_\n\n### Validations\n\n- [X] Follow our [Code of Conduct](https://vuejs.org/about/coc.html)\n- [X] Read the [docs](https://vitepress.vuejs.org).\n- [X] Read the [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md).\n- [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.",[],735,"closed","Custom element support","2023-01-21T14:34:18Z","https://github.com/vuejs/vitepress/issues/735",0.68685496,{"description":3075,"labels":3076,"number":3078,"owner":3029,"repository":3030,"state":3069,"title":3079,"updated_at":3080,"url":3081,"score":3082},"### Describe the bug\r\n\r\nThe header anchors are not accessible to screen reader users.\r\n\r\n```html\r\n\u003Ch1 id=\"what-is-vitepress\" tabindex=\"-1\">\r\n What is VitePress?\r\n \u003Ca class=\"header-anchor\" href=\"#what-is-vitepress\" aria-hidden=\"true\">#\u003C/a>\r\n\u003C/h1>\r\n```\r\n\r\nSetting `aria-hidden` on focusable elements (that are not hidden from **all** users) fails test \"[aria-hidden elements do not contain focusable elements](https://dequeuniversity.com/rules/axe/4.4/aria-hidden-focus?utm_source=lighthouse&utm_medium=devtools)\".\r\n\r\nI'm preparing a PR to fix this issue.\r\n\r\n### Reproduction\r\n\r\nNo special configuration necessary. Header anchors are enabled by default.\r\n\r\nThis issue can be tested on the official [VitePress](https://vitepress.vuejs.org/guide/what-is-vitepress) site or any other basic vitepress deployment using the default-theme.\r\n\r\n### Expected behavior\r\n\r\nProvide an accessible default configuration for `markdown-it-anchor` and update styling of header-anchors accordingly.\r\n\r\nA possible solution could look like this:\r\n\r\n```html\r\n\u003Cdiv class=\"header-wrapper\">\r\n \u003Ch1 id=\"what-is-vitepress\" tabindex=\"-1\">What is VitePress?\u003C/h1>\r\n \u003Ca class=\"header-anchor\" href=\"#what-is-vitepress\" aria-label=\"Permalink to \"What is VitePress?\"\">#\u003C/a>\r\n\u003C/div>\r\n```\r\n\r\nA viable `markdown-it-anchor` configuration could look like this.\r\n```js\r\n{\r\n anchor: {\r\n permalink: MdItAnchor.permalink.linkAfterHeader({\r\n style: \"aria-label\",\r\n assistiveText: (title) => `Permalink to \"${title}\"`,\r\n visuallyHiddenClass: \"visually-hidden\",\r\n wrapper: ['\u003Cdiv class=\"header-wrapper\">', \"\u003C/div>\"],\r\n }),\r\n },\r\n}\r\n```\r\n\r\nAdditionally, some updates for anchor styling are necessary too.\r\n```css\r\n.vp-doc .header-wrapper {\r\n position: relative;\r\n}\r\n\r\n.vp-doc .header-wrapper .header-anchor {\r\n line-height: 32px;\r\n position: absolute;\r\n top: 0;\r\n}\r\n\r\n.vp-doc .header-wrapper h1 + .header-anchor {\r\n line-height: 40px;\r\n font-size: 32px;\r\n}\r\n\r\n.vp-doc .header-wrapper h2 + .header-anchor {\r\n padding-top: 25px;\r\n line-height: 32px;\r\n font-size: 24px;\r\n}\r\n\r\n.vp-doc .header-wrapper h3 + .header-anchor {\r\n line-height: 28px;\r\n font-size: 20px;\r\n}\r\n\r\n.vp-doc .header-anchor:hover,\r\n.vp-doc .header-anchor:focus,\r\n.vp-doc h1:hover + .header-anchor,\r\n.vp-doc h2:hover + .header-anchor,\r\n.vp-doc h3:hover + .header-anchor,\r\n.vp-doc h4:hover + .header-anchor,\r\n.vp-doc h5:hover + .header-anchor,\r\n.vp-doc h6:hover + .header-anchor {\r\n opacity: 1;\r\n}\r\n```\r\n\r\n### System Info\r\n\r\n```shell\r\nSystem:\r\n OS: Linux 5.15 Ubuntu 20.04.5 LTS (Focal Fossa)\r\n CPU: (8) x64 Intel(R) Xeon(R) CPU E3-1505M v5 @ 2.80GHz\r\n Memory: 19.26 GB / 31.13 GB\r\n Container: Yes\r\n Shell: 5.0.17 - /bin/bash\r\nBinaries:\r\n Node: 18.14.0 - ~/.nvm/versions/node/v18.14.0/bin/node\r\n Yarn: 1.22.19 - ~/.nvm/versions/node/v18.14.0/bin/yarn\r\n npm: 9.3.1 - ~/.nvm/versions/node/v18.14.0/bin/npm\r\nBrowsers:\r\n Chrome: 110.0.5481.177\r\n Chromium: 110.0.5481.100\r\n Firefox: 110.0.1\r\n```\r\n\r\n\r\n### Additional context\r\n\r\nMore details about test \"aria-hidden elements do not contain focusable elements\" can be found at [https://dequeuniversity.com/rules/axe/4.4/aria-hidden-focus](https://dequeuniversity.com/rules/axe/4.4/aria-hidden-focus).\r\n\r\n### Validations\r\n\r\n- [X] Follow our [Code of Conduct](https://vuejs.org/about/coc.html)\r\n- [X] Read the [docs](https://vitepress.vuejs.org).\r\n- [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.",[3077],{"name":3020,"color":3021},2039,"Header anchors not accessible to screen reader users.","2023-03-22T00:03:24Z","https://github.com/vuejs/vitepress/issues/2039",0.6911787,{"description":3084,"labels":3085,"number":3086,"owner":3029,"repository":3030,"state":3069,"title":3087,"updated_at":3088,"url":3089,"score":3090},"### Is your feature request related to a problem? Please describe.\n\nNo\n\n### Describe the solution you'd like\n\nThe custom container are a very useful feature and it can be configurable in the .vitepress/config.js file with color for \r\nname,border, border-dark, background, background-dark in the config file with these 5 options i think it will make a better for a better blog points.\n\n### Describe alternatives you've considered\n\nHaving the lack of customization for the custom container boxes. I am aware that you can create components to do the same things but the \"::: name :::\" syntax is better to view in markdown as well as more read able than having it wrapped inside a html tag.\n\n### Additional context\n\n_No response_\n\n### Validations\n\n- [X] Follow our [Code of Conduct](https://vuejs.org/about/coc.html)\n- [X] Read the [docs](https://vitepress.vuejs.org).\n- [X] Read the [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md).\n- [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.",[],1246,"Adding Custom Containers from the config.js file ","2023-01-21T14:26:51Z","https://github.com/vuejs/vitepress/issues/1246",0.7012965,{"description":3092,"labels":3093,"number":3095,"owner":3029,"repository":3030,"state":3069,"title":3096,"updated_at":3097,"url":3098,"score":3099},"### Is your feature request related to a problem? Please describe.\r\n\r\nYes, when I verify my documentation site at https://agnosticui.com/ with the [IBM Equal Access Accessibility Checker](https://chrome.google.com/webstore/detail/ibm-equal-access-accessib/lkcagbfjnkomcinoddgooolagloogehp?hl=en-US) it fails hard. This is unfortunate, because one of the things I'm trying to point out is that the UI component library offered is accessible. I lose credibility if the documentation site itself is not a11y compliant.\r\n\r\nI actually get even worse results when I scan the vitepress docs themselves. So while this is a feature request, I would also call it a bug. Lighthouse which I would call more permissive also shows errors in the Accessibility category (but if the IBM checker passes Lighthouse will too).\r\n\r\n### Describe the solution you'd like\r\n\r\nEnsure the code produced by Vitepress is a11y compliant.\r\n\r\nI saw violations with the following rules which can easily be cross-referenced at:\r\nhttps://www.ibm.com/able/requirements/requirements\r\n\r\n1.3.1 Info and Relationships\r\n1.4.3 Contrast (Minimum)\r\n2.4.1 Bypass Blocks\r\n2.5.3 Label in Name\r\n4.1.2 Name, Role, Value\r\n\r\n_Note: this is only from scanning the top-level page. I saw a couple of other warnings on other pages, but this is a good start._\r\n\r\n### Describe alternatives you've considered\r\n\r\nThere are no alternatives. These issues are making Vitepress generated sites less inclusive than they could be meaning certain site users are being excluded which is a real bummer since Vitepress is otherwise producing such lovely sites.\r\n\r\n### Additional context\r\n\r\n\r\n\r\n\r\n### Validations\r\n\r\n- [X] Follow our [Code of Conduct](https://vuejs.org/coc)\r\n- [X] Read the [docs](https://vitepress.vuejs.org/).\r\n- [X] Read the [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/master/.github/contributing.md).\r\n- [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.",[3094],{"name":3020,"color":3021},466,"Make Vitepress Accessible","2023-02-04T00:04:08Z","https://github.com/vuejs/vitepress/issues/466",0.7059606,{"description":3101,"labels":3102,"number":3104,"owner":3029,"repository":3030,"state":3069,"title":3105,"updated_at":3106,"url":3107,"score":3108},"### Describe the bug\r\n\r\nThe `\u003CContent />` component wraps the code with a \"position: relative\" styled div. \r\n\r\n\u003Cimg width=\"656\" alt=\"Screenshot 2023-07-30 at 9 43 37 PM\" src=\"https://github.com/vuejs/vitepress/assets/90354202/a7f83520-edc3-415d-b851-2487693e1ba9\">\r\n\r\n\r\n### Reproduction\r\n\r\nThe \u003CContent /> component wraps the code with a \"position: relative\" styled div. \r\n\r\n### Expected behavior\r\n\r\nThere is no documentation on how to disable that from happening and it shouldn't do that in the first place anyway. \r\n\r\n### System Info\r\n\r\n```sh\r\nv1.0.0-beta.7\r\n```\r\n\r\n\r\n### Additional context\r\n\r\n_No response_\r\n\r\n### Validations\r\n\r\n- [X] Check if you're on the [latest VitePress version](https://github.com/vuejs/vitepress/releases/latest).\r\n- [X] Follow our [Code of Conduct](https://vuejs.org/about/coc.html)\r\n- [X] Read the [docs](https://vitepress.dev).\r\n- [X] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.",[3103],{"name":3058,"color":3059},2712,"The \u003CContent /> component wraps the code with a \"position: relative\" styled div.","2023-08-11T00:04:38Z","https://github.com/vuejs/vitepress/issues/2712",0.71344644,{"description":3110,"labels":3111,"number":3113,"owner":3029,"repository":3030,"state":3069,"title":3114,"updated_at":3115,"url":3116,"score":3117},"### Is your feature request related to a problem? Please describe.\r\n\r\nWhen I write documentation, I sometimes want to have some sort of introductory paragraph to set some context for the readers. These kinds of introductory paragraphs are often visually emphasized to catch attention and get even more impactful. Usually, the emphasis relies on styling (e.g. bigger font size, bolder font weights, etc).\r\n\r\nI really think it would be convenient for many users to be able to specify introductions in a straight-forward and _markdownish_ way, so that such content gets emphasized through styling while preserving other markdown rules and features .\r\n\r\n### Describe the solution you'd like\r\n\r\nTo address this need, we basically want to take a whole identified block and apply some styles to make it stand out. It turns out this kind of feature already exists in Vitepress: [custom containers](https://vitepress.dev/guide/markdown#custom-containers). These perfectly match our needs because:\r\n- they can be clearly identified because the syntax really pops out\r\n- their content still benefit from markdown syntax\r\n- they contextually provide their content a special, highlighted role\r\n\r\nMy belief is that it makes sense to also provide a `intro` custom container because those share a common philosophy. However, there is a slight difference : unlike other custom containers, I feel like it does not make any sense for `intro`s to include default and custom titles because well… they're introductions).\r\n\r\n### Describe alternatives you've considered\r\n\r\nI used to work this around by explicitly wrapping my introductory paragraph with a `\u003Cp class=\"intro\">\u003C/p>` block, and defining some CSS on the `.intro` selector, since it is supported. This works just fine, but being in a explicit HTML block prevents me from benefiting from other markdown features. For example, this would not work as expected:\r\n\r\n```md\r\n\u003Cp class=\"intro\">\r\n [click me](https://github.com)\r\n\u003C/p>\r\n```` \r\n\r\n### Additional context\r\n\r\nI've came up with the following draft PR: #2474. It's marked as draft because [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md) state that we \"should open a suggestion issue first \", but could not resist to give it a try.\r\n\r\n### Validations\r\n\r\n- [X] Follow our [Code of Conduct](https://vuejs.org/about/coc.html)\r\n- [X] Read the [docs](https://vitepress.dev).\r\n- [X] Read the [Contributing Guidelines](https://github.com/vuejs/vitepress/blob/main/.github/contributing.md).\r\n- [X] Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.",[3112],{"name":3020,"color":3021},2473,"Introduction custom container","2023-07-29T00:04:10Z","https://github.com/vuejs/vitepress/issues/2473",0.722598,["Reactive",3119],{},["Set"],["ShallowReactive",3122],{"$fTRc1wZytZ_XrK4EfJfei_Sz-An4H4Yy6syhVxH_PVJc":-1,"$fkXBN3xcQQZekO3-V387enGlMij82y1dLakC7uf1mOjo":-1},"/vuejs/vitepress/4846"]