Hello stackers, let’s continue our research into VitePress, VuePress alternative. So for those of you still figuring out in making a documentation but want to use a different tool of course, it is recommended for you to use this framework. Very interesting and definitely different from the others framework.
Simple, powerful, and performant. Meet the modern SSG framework you’ve always wanted.
vitepress
Okay now we move to the Quick Start section :
mkdir vitepress-starter && cd vitepress-starter
yarn init
yarn add --dev vitepress vue
mkdir docs && echo '# Hello VitePress' > docs/index.md
add inside package.json
{
...
"scripts": {
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:serve": "vitepress serve docs"
},
...
}
serve
yarn docs:dev
and now we look at folder structure:
.
├─ docs
│ ├─ getting-started.md
│ └─ index.md
└─ package.json
Additional
VitePress is the spiritual successor to VuePress. It replaces VuePress’ Vue 2 + webpack internals with Vue 3 + Vite, and adds a number of production improvements. Most notably, it supports mixing Vue components in markdown with partial hydration (for the markdown part). It loads a lightweight Vue application upfront in return for faster, SPA-style subsequent navigations. Vite’s docs is built with VitePress, we are also in the process of rebuilding the Vue documentation with VitePress. Also note that although the default theme is designed for documentation, both VuePress and VitePress actually support arbitrary custom themes using Vue. As an example, the Vue blog is built with VitePress and a custom blog theme.
for the full documentation you can follow this link.. cyaaa.
Thank you sir!