\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.",[3020],{"name":3021,"color":3022},"stale","ededed",2432,"vuejs","vitepress","open","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.65608793,{"description":3032,"labels":3033,"number":3037,"owner":3024,"repository":3025,"state":3038,"title":3039,"updated_at":3040,"url":3041,"score":3042},"### Describe the bug\n\nindex.md not support markdown\n\n### Reproduction\n\n\"I'm encountering an issue with VitePress where Markdown syntax in my index.md file doesn't seem to apply the expected styles on the homepage, whereas in VuePress, this works as anticipated. For instance, if I wish to include some introductory text on the main page and then guide users to the navigation bar, it appears that I need to manually write the CSS styles. Why can't I utilize Markdown for styling in this case?\"\n\n### Expected behavior\n\n\"I'm encountering an issue with VitePress where Markdown syntax in my index.md file doesn't seem to apply the expected styles on the homepage, whereas in VuePress, this works as anticipated. For instance, if I wish to include some introductory text on the main page and then guide users to the navigation bar, it appears that I need to manually write the CSS styles. Why can't I utilize Markdown for styling in this case?\"\n\n### System Info\n\n```Text\n\"I'm encountering an issue with VitePress where Markdown syntax in my index.md file doesn't seem to apply the expected styles on the homepage, whereas in VuePress, this works as anticipated. For instance, if I wish to include some introductory text on the main page and then guide users to the navigation bar, it appears that I need to manually write the CSS styles. Why can't I utilize Markdown for styling in this case?\"\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.",[3034],{"name":3035,"color":3036},"bug: pending triage","e99695",3409,"closed","index.md","2024-01-13T00:04:51Z","https://github.com/vuejs/vitepress/issues/3409",0.6736052,{"description":3044,"labels":3045,"number":3049,"owner":3024,"repository":3025,"state":3038,"title":3050,"updated_at":3051,"url":3052,"score":3053},"I am looking into porting the using vue in Markdown from vuepress: \r\nhttps://vuepress.vuejs.org/guide/using-vue.html\r\n\r\nIf I understand correctly, vitepress doesn't want to auto register components by convention as Vuepress does. Is this the case? I actually liked this feature, but I understand that vitepress wants to keep the moving parts as small as possible.\r\n\r\nWhat is the recommended way to register the components? I see that in vue-router-next docs they are registered globally inside `enhanceApp`: https://github.com/vuejs/vue-router-next/search?q=HomeSponsors.\r\nSame as with this comment: https://github.com/vuejs/vitepress/issues/92#issuecomment-724645482\r\n\r\nShould we document this way in the docs?\r\n\r\nSome thoughts about this. It would be great that users that want to use the default theme as is, do not need to learn straight away about enhanceApp to be able to use a vue component in their markdown.\r\n\r\nIf auto registering by convention in a folder like `.vitepress/components` is not an option, could we import them directly in the markdown?\r\n\r\n```markdown\r\n# Docs\r\n\r\nThis is a .md using a custom component\r\n\r\n\u003CCustomComponent />\r\n\r\n## More docs\r\n\r\n...\r\n\r\n\u003Cscript setup>\r\n import CustomComponent from '../components/CustomComponent.vue'\r\n\u003C/script>\r\n```\r\n\r\nScript & style hoisting is working in vitepress: https://vuepress.vuejs.org/guide/using-vue.html#script-style-hoisting, but I tried this example to import a Component and it is not at this point.\r\n",[3046],{"name":3047,"color":3048},"docs","0075ca",157,"Recommended way to use Custom Vue components in .md","2023-01-21T16:04:10Z","https://github.com/vuejs/vitepress/issues/157",0.6752456,{"description":3055,"labels":3056,"number":3060,"owner":3024,"repository":3025,"state":3038,"title":3061,"updated_at":3062,"url":3063,"score":3064},"Hello!\r\n\r\nDocumentation says \"...allowing the user to freely mix Vue components inside markdown content...\" but it doesn't work as VuePress.\r\n\r\nTo reproduce init project according to documentation.\r\nCreate `.vitepress/components/NewComponent.vue` with a `\u003Ctemplate>\u003Cp>Hello VitePress\u003C/p>\u003C/template>`\r\nTry to use `\u003CNewComponent />` inside index.md\r\n\r\nExpected to see rendered component on the page see nothing.\r\nConsole says \"Failed to resolve component: NewComponent\"\r\n\r\nWhat I'm doing wrong? ",[3057],{"name":3058,"color":3059},"question","5D5FAE",101,"Cant figure out how to use components inside .md file","2023-01-21T16:24:22Z","https://github.com/vuejs/vitepress/issues/101",0.6867619,{"description":3066,"labels":3067,"number":3069,"owner":3024,"repository":3025,"state":3038,"title":3070,"updated_at":3071,"url":3072,"score":3073},"### 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.",[3068],{"name":3021,"color":3022},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.68855673,{"description":3075,"labels":3076,"number":3077,"owner":3024,"repository":3025,"state":3038,"title":3078,"updated_at":3079,"url":3080,"score":3081},"### Is your feature request related to a problem? Please describe.\n\nCurrently Vitepress requires this directory structure:\r\n\r\n```\r\n.\r\n├─ docs\r\n│ ├─ .vitepress\r\n│ │ └─ config.js\r\n│ └─ index.md\r\n└─ package.json\r\n```\r\n\r\nBut I just want to use Vitepress in a non-JS project, so I don't want `package.json` at my project root.\n\n### Describe the solution you'd like\n\nI want to have `package.json` under the `docs/` dir alongside the `.vitepress` config dir and `index.md`:\r\n\r\n```\r\n.\r\n├─ .git\r\n├─ docs\r\n│ ├─ .vitepress\r\n│ │ └─ config.js\r\n│ ├─ pt-br\r\n│ │ └─ index.md\r\n│ ├─ package.json\r\n│ └─ index.md\r\n└─ rest of my project\r\n```\n\n### Describe alternatives you've considered\n\nHaving nested `docs/` directories works but is cumbersome:\r\n\r\n```\r\n.\r\n├─ .git\r\n├─ docs\r\n│ ├─ docs\r\n│ │ ├─ .vitepress\r\n│ │ │ └─ config.js\r\n│ │ ├─ pt-br\r\n│ │ │ └─ index.md\r\n│ │ └─ index.md\r\n│ └─ package.json\r\n└─ rest of my project\r\n```\n\n### Additional context\n\nI have been using Vuepress with `vuepress-vite@2.0.0-beta.22` this way, but haven't been keeping up with it's updates, so it might have changed this behaviour in a more recent Beta release, I am not sure.\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.",[],844,"Support for other directory structures for use in non-JS projects","2023-01-21T14:33:59Z","https://github.com/vuejs/vitepress/issues/844",0.6908476,{"description":3083,"labels":3084,"number":3085,"owner":3024,"repository":3025,"state":3038,"title":3086,"updated_at":3087,"url":3088,"score":3089},"### 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.69133884,{"description":3091,"labels":3092,"number":3093,"owner":3024,"repository":3025,"state":3038,"title":3094,"updated_at":3095,"url":3096,"score":3097},"### Is your feature request related to a problem? Please describe.\n\nMy library exports both vue components as well as js functions and ts symbols. Custom documentation tools produce markdown for non-vue code and I don't want to clutter my docs folder with auto-generated files.\n\n### Describe the solution you'd like\n\nReplace current `srcDir` and `outDir` configuration values with a new binding type that allows pairs of src->out information.\r\n\r\nMaybe something like\r\n```ts\r\nexport interface DirMapping {\r\n srcDir: string; /** look for input files here */\r\n outDir: string; /** write transformed output here */\r\n}\r\n```\r\n\r\n```ts\r\nimport { defineConfig } from \"vitepress\";\r\nexport default defineConfig({\r\n ...\r\n dirs: [\r\n {srcDir: \"./\", outDir:\"./dist\"},\r\n {srcDir: \"../generated\", outDir: \"./dist/generated\"}\r\n ] as DirMapping[],\r\n ...\r\n})\r\n```\r\n\r\n`ioPairs` should be optional. When not specified, the original `srcDir` and `outDir` entries are used. If `ioPairs` is populated those pairs should be used instead of `srcDir` and `outDir`\n\n### Describe alternatives you've considered\n\nmanually creating markdown files under `./docs` which only contain an import line for the out-of-tree generated files. Like so\r\n\r\n\r\n`docs/useFoo.md` contains only the string `\u003C!--@include: ../../generated//useFoo.md -->`\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.",[],1571,"multiple srcDir entries?","2023-03-29T00:04:11Z","https://github.com/vuejs/vitepress/issues/1571",0.6984847,{"description":3099,"labels":3100,"number":3102,"owner":3024,"repository":3025,"state":3038,"title":3103,"updated_at":3104,"url":3105,"score":3106},"### Describe the bug\n\nI have `.github/workflows/deploy.yml` set up in my project root as doc instructed. And Github action succeeds. However, when I visit my pages, its not vitepress that I see but regular github pages.\r\n\r\nIs there some settings I have to alter in github repository itself?\n\n### Reproduction\n\n\r\nThis is my app structure \r\n\r\n```\r\n- root\r\n - docs (vitepress)\r\n - theme/index.js\r\n - config.js\r\n - index.md \r\n - src (src for my vue component lib)\r\n - dist (for my vue component lib)\r\n```\r\n\r\nThis is my github workflow deploy.yml\r\n```\r\nname: Deploy\r\n\r\non:\r\n push:\r\n branches:\r\n - master\r\n\r\njobs:\r\n deploy:\r\n runs-on: ubuntu-latest\r\n steps:\r\n - uses: actions/checkout@v2\r\n - uses: actions/setup-node@v3\r\n with:\r\n node-version: 16\r\n cache: npm\r\n - run: npm ci\r\n\r\n - name: Build\r\n run: npm run docs:build\r\n\r\n - name: Deploy\r\n uses: peaceiris/actions-gh-pages@v3\r\n with:\r\n github_token: ${{ secrets.GITHUB_TOKEN }}\r\n publish_dir: docs/.vitepress/dist\r\n```\n\n### Expected behavior\n\nBuilt vitepress in github pages.\n\n### System Info\n\n```shell\n(Local)\r\nSystem:\r\n OS: macOS 12.2\r\n CPU: (8) arm64 Apple M1 Pro\r\n Memory: 99.72 MB / 16.00 GB\r\n Shell: 5.8 - /bin/zsh\n```\n\n\n### Additional context\n\nMy repository is in an organization.\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.",[3101],{"name":3035,"color":3036},1144,"Github pages shows index.md natively","2023-01-21T14:26:58Z","https://github.com/vuejs/vitepress/issues/1144",0.69878364,{"description":3108,"labels":3109,"number":3111,"owner":3024,"repository":3025,"state":3038,"title":3112,"updated_at":3113,"url":3114,"score":3115},"### Describe the bug\n\nI want to use the vue component in vitepress. I have read the documentation on the official website, but when I do it, I encounter an error like this.\r\n```bash\r\n[plugin:vite:vue] Tags with side effect (\u003Cscript> and \u003Cstyle>) are ignored in client component templates.\r\n```\r\n\r\nI don't understand what I'm encountering, I just want to achieve the effect here in this vue document\r\n\r\n> https://cn.vuejs.org/guide/reusability/composables.html#vs-react-hooks\r\n\r\n\r\n\r\n\n\n### Reproduction\n\nhttps://stackblitz.com/edit/vite-dn63jg?file=docs%2Fhooks%2FuseMouse.js,docs%2Fexample.md\n\n### Expected behavior\n\nThe documentation on the official website makes me understand the difficulty or the need for a better demo?\n\n### System Info\n\n```Text\nSystem:\r\n OS: Windows 11 10.0.22631\r\n CPU: (20) x64 13th Gen Intel(R) CoreT i7-13800H\r\n Memory: 17.07 GB / 31.74 GB\r\n Binaries:\r\n Node: 20.11.0 - ~\\AppData\\Local\\pnpm\\node.EXE\r\n npm: 10.2.4 - ~\\AppData\\Local\\pnpm\\npm.CMD\r\n pnpm: 8.14.1 - ~\\AppData\\Local\\pnpm\\pnpm.EXE\r\n Browsers:\r\n Edge: Chromium (120.0.2210.133)\r\n Internet Explorer: 11.0.22621.1\r\n npmPackages:\r\n vitepress: 1.0.0-rc.39 => 1.0.0-rc.39\n```\n\n\n### Additional context\n\nPlease tell me the correct way to write it, thank you\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.",[3110],{"name":3035,"color":3036},3485,"Using vue to report errors in markdown","2024-01-29T00:04:28Z","https://github.com/vuejs/vitepress/issues/3485",0.69914865,["Reactive",3117],{},["Set"],["ShallowReactive",3120],{"$fTRc1wZytZ_XrK4EfJfei_Sz-An4H4Yy6syhVxH_PVJc":-1,"$fdWyz9JQLe-X5BNWKrTXHab-A5Zf_r8Y0-3dkBmqNe6g":-1},"/vuejs/vitepress/987"]