\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.",[2882],{"name":2869,"color":2870},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.756037,{"description":2889,"labels":2890,"number":2891,"owner":2872,"repository":2873,"state":2892,"title":2893,"updated_at":2894,"url":2895,"score":2896},"**Is your feature request related to a problem? Please describe.**\r\n\r\nCurrently a VuePress user and excited to move to VitePress (primarily because I've written my own VP themes from scratch, and this seems to be the main design goal for v3) but:\r\n\r\n- there are various key differences between the frameworks (bundler, plugins, config)\r\n- there are significant intentional omissions in v3 (rather large list in the docs)\r\n- it's still in development\r\n\r\nAs a new / migrating user, it's a bit of a minefield and difficult to know where to start when something is omitted.\r\n\r\n**Describe the solution you'd like**\r\n\r\nRather than clogging up the issues with questions, it would be cool to get an Awesome VitePress list going, so users could find alternative plugins, or dig through the code of known solutions (i.e. the Vue Blog) and see how it's been solved before.\r\n\r\n**Describe alternatives you've considered**\r\n\r\nClog up the issues with questions, bug @kiaking on Twitter, Google solutions, etc.\r\n\r\n**Additional context**\r\n\r\nHappy to help search and review resources to get it started.\r\n\r\n",[],253,"closed","List of examples or some kind of Awesome VitePress repo","2023-01-28T15:54:22Z","https://github.com/vuejs/vitepress/issues/253",0.7049625,{"description":2898,"labels":2899,"number":2900,"owner":2872,"repository":2873,"state":2892,"title":2901,"updated_at":2902,"url":2903,"score":2904},"**Is your feature request related to a problem? Please describe.**\r\nIs there any documentation about vitepress?\r\nLike: https://www.vuepress.cn/\r\n",[],107,"Is there any documentation about vitepress?","2023-01-21T16:24:21Z","https://github.com/vuejs/vitepress/issues/107",0.72605217,{"description":2906,"labels":2907,"number":2911,"owner":2872,"repository":2873,"state":2892,"title":2912,"updated_at":2913,"url":2914,"score":2915},"### Describe the bug\n\n很多时候在 `vitepress` 中难免使用到 `document`,但是 `vitepress` 使用服务端渲染方式,如何避免其打包的错误呢?\r\n\r\n有什么第三方插件推荐或者配置项吗?\r\n\r\n\u003Chr />\r\n\r\nIt is inevitable to use `document` in `vitepress` many times, but how to avoid the packaging error when` vitepress` uses the server-side rendering method?\r\n\r\nAre there any third-party plug-in recommendations or configuration items?\n\n### Reproduction\n\n```vue\r\n\u003Cscript setup>\r\n console.log(document)\r\n\u003C/script>\r\n```\r\n\r\n\r\n\n\n### Expected behavior\n\nBuild ok\n\n### System Info\n\n```shell\n\"vitepress\": \"^1.0.0-alpha.4\",\r\n\"vue\": \"^3.2.33\"\n```\n\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] Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.",[2908],{"name":2909,"color":2910},"question","5D5FAE",1120,"document is not defined","2023-01-21T14:28:51Z","https://github.com/vuejs/vitepress/issues/1120",0.7266962,{"description":2917,"labels":2918,"number":2919,"owner":2872,"repository":2873,"state":2892,"title":2920,"updated_at":2921,"url":2922,"score":2923},"### Is your feature request related to a problem? Please describe.\n\nI have some `*.md` files under `docs/component/`, but I also need some `*.vue` files under `docs/component/`.\n\n### Describe the solution you'd like\n\nI want to move the dir like `component/`, `public/` to the `.vitepress/` dir? Is there any problem?\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.",[],1951,"Is possible to make docs/ only contains markdown file only?","2023-02-27T00:04:36Z","https://github.com/vuejs/vitepress/issues/1951",0.7272155,{"description":2925,"labels":2926,"number":2928,"owner":2872,"repository":2873,"state":2892,"title":2929,"updated_at":2930,"url":2931,"score":2932},"### Is your feature request related to a problem? Please describe.\n\nI've built up great docs in Vitepress but I need an API reference built off an OpenApi 3.1 spec. I'm having trouble finding a clean, \"Vitepressy\" way of doing this. \n\n### Describe the solution you'd like\n\nI'd like to setup a Vitepress layout (e.g., \"openapi\") and simply point to either a URL or file OpenAPI 3.1 spec which renders as nicely as [Stoplight Elements](https://stoplight.io/open-source/elements) but inherits the Vitepress theme, navigation, dark mode/lightmode etc.\n\n### Describe alternatives you've considered\n\nI tried to wrap [Stoplight Elements](https://stoplight.io/open-source/elements), but it was very heavy and slow and I couldn't figure out how to get the theme to match:\r\n```\r\n---\r\nlayout: false\r\n---\r\n\r\n\u003Clink rel=\"stylesheet\" href=\"https://unpkg.com/@stoplight/elements/styles.min.css\"/>\r\n\r\n\u003Ctemplate>\r\n \u003Ccomponent\r\n src=\"https://unpkg.com/@stoplight/elements/web-components.min.js\"\r\n :is=\"'script'\"\r\n >\u003C/component>\r\n\u003C/template>\r\n\r\n\u003CClientOnly>\r\n \u003Celements-api\r\n apiDescriptionUrl=\"https://raw.githubusercontent.com/stoplightio/Public-APIs/master/reference/zoom/openapi.yaml\"\r\n layout=\"sidebar\"\r\n router=\"hash\"\r\n />\r\n\u003C/ClientOnly>\r\n```\r\n If there are good other options out there that I don't know about, I'd gladly settle for the recommendation.\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.dev).\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.",[2927],{"name":2869,"color":2870},2091,"Provide supported approach for rendering API docs generated from an OpenAPI spec","2023-08-23T00:04:05Z","https://github.com/vuejs/vitepress/issues/2091",0.7386576,{"description":2934,"labels":2935,"number":2936,"owner":2872,"repository":2873,"state":2892,"title":2937,"updated_at":2938,"url":2939,"score":2940},"### Is your feature request related to a problem? Please describe.\r\n\r\nThe markdown of the component is expected to be written under the packages, not in the docs directory.\r\n\r\nLike Dumi: https://d.umijs.org/\r\n\r\nThis will make our documentation more maintainable.\r\n\r\nThis is important when developing monorepo projects.\r\n\r\n### Describe the solution you'd like\r\n\r\nThe directory structure is as follows\r\n\r\n```bash\r\n├── docs/\r\n│ ├── .vitepress/\r\n│ │ ├── dist/\r\n│ │ └── config.js\r\n│ └── index.md\r\n├── packages/\r\n│ └── package-A/\r\n│ ├── dist/\r\n│ ├── node_modules/\r\n│ ├── src/\r\n│ │ ├── ...\r\n│ │ ├── func-A/\r\n│ │ │ ├── __tests__/ # Jest\r\n│ │ │ ├── demos/ # Vue Demos\r\n│ │ │ │ ├── Basic.vue # Example Component\r\n│ │ │ │ └── Timer.vue # Example Component\r\n│ │ │ ├── index.md # API Markdown ☞☞ Expectation: Doc documentation can be written here, can be compiled by vitepress, instead of having to be written in the docs directory\r\n│ │ │ └── index.ts # Source Code\r\n│ │ ├── ...\r\n│ │ └── index.ts\r\n│ ├── README.md\r\n│ ├── package.json\r\n│ ├── tsconfig.json\r\n│ └── typings.d.ts\r\n├── .editorconfig\r\n├── .eslintignore\r\n├── .eslintrc.js\r\n├── .fatherrc.ts\r\n├── .gitignore\r\n├── .npmrc\r\n├── .prettierignore\r\n├── .prettierrc\r\n├── README.md\r\n├── lerna.json\r\n├── package.json\r\n├── pnpm-lock.yaml\r\n├── pnpm-workspace.yaml\r\n└── tsconfig.json\r\n```\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.vuejs.org).\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.",[],987,"Documentation in the same style as dumi","2023-02-04T00:04:07Z","https://github.com/vuejs/vitepress/issues/987",0.74155486,{"description":2942,"labels":2943,"number":2947,"owner":2872,"repository":2873,"state":2892,"title":2948,"updated_at":2949,"url":2950,"score":2951},"### Describe the bug\n\nafter migrate package.json\r\n```json\r\n\"directories\": {\r\n \"doc\": \"records\"\r\n },\r\n```\r\nsitemap generate with sitemap.hostname but not add /records after host name\n\n### Reproduction\n\nsitemap.xml\n\n### Expected behavior\n\nloc shoud be http://test.com/records/ok.html not http://test.com/ok.html\n\n### System Info\n\n```Text\n\"vitepress\": \"^1.1.0\"\n```\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.",[2944],{"name":2945,"color":2946},"bug: pending triage","e99695",3799,"Vitepress dose not generate sitemap with directories:doc","2024-05-05T04:41:50Z","https://github.com/vuejs/vitepress/issues/3799",0.74656045,{"description":2953,"labels":2954,"number":2958,"owner":2872,"repository":2873,"state":2892,"title":2959,"updated_at":2960,"url":2961,"score":2962},"**Is your feature request related to a problem? Please describe.**\r\n\r\nI would like to be able to display a collection of pages (e.g. my latest blog posts or an alphabetized list of API docs).\r\nVuePress has `$site.pages`, but VitePress does not ship metadata about all pages, which is great except when I need that data for certain pages.\r\n\r\n**Describe the solution you'd like**\r\n\r\nI would like to specify collections of pages that I need metadata for in config.js, for example:\r\n\r\n```js\r\nmodule.exports = {\r\n title: \"My Tech Blog\",\r\n collections: [\r\n {\r\n name: 'blog',\r\n directory: '_posts/',\r\n layout: 'BlogPostLayout',\r\n },\r\n {\r\n name: 'api',\r\n directory: 'guide/api/',\r\n layout: 'TechDocLayout',\r\n }\r\n ],\r\n};\r\n```\r\n\r\nThis would produce an array of metadata for pages inside the **_posts** directory could then be accessed via `$site.collections.blog`\r\n\r\nI've also included a layout option that could be used to define a default layout for pages in that collection. That's a separate idea, but the point is that collections could have additional benefits.\r\n\r\nYou could possibly specify which metadata you need - e.g. you may or may not need the frontmatter for every page in the collection.\r\n\r\nI've borrowed the term \"collections\" from [NetlifyCMS](https://www.netlifycms.org/docs/collection-types/), which I use with VuePress currently.\r\n\r\n**Describe alternatives you've considered**\r\n\r\nAlternatively, you could simply have a config option to ship metadata for all pages, but that would be all or nothing.\r\n\r\n**Additional context**\r\n\r\nHere's an example of how I've implemented collections in a VuePress theme: [themeConfig.js](https://github.com/petedavisdev/vuepress-theme-base/blob/master/example/.vuepress/themeConfig.js), [PostList.vue](https://github.com/petedavisdev/vuepress-theme-base/blob/master/theme/global-components/PostList.vue#L40), [GlobalLayout.vue](https://github.com/petedavisdev/vuepress-theme-base/blob/master/theme/layouts/GlobalLayout.vue#L28)\r\n",[2955],{"name":2956,"color":2957},"keep-open","96DAA7",96,"Metadata for collections of pages (blogs etc.)","2023-05-08T16:09:23Z","https://github.com/vuejs/vitepress/issues/96",0.74684495,["Reactive",2964],{},["Set"],["ShallowReactive",2967],{"$fTRc1wZytZ_XrK4EfJfei_Sz-An4H4Yy6syhVxH_PVJc":-1,"$fGk0MpQyAEBldzO-ZnKFsLkWgWpCh5cppVenRM9h_35g":-1},"/vuejs/vitepress/2201"]