Getting Started with VuePress
VuePress is a Markdown-centered static site generator. You can use it to create documentation, blogs, personal websites, and more.
Features
- 📝 Markdown First: Write content in Markdown
- 🎨 Vue Powered: Use Vue components in Markdown
- 🚀 High Performance: Generate static HTML with SPA support
- 💅 Customizable: Rich theme and plugin ecosystem
Quick Installation
# Using npm
npm init vuepress@latest my-blog
# Using pnpm
pnpm init vuepress@latest my-blog
# Using yarn
yarn init vuepress@latest my-blogProject Structure
my-blog/
├── .vuepress/ # Configuration directory
│ └── config.ts # Configuration file
├── docs/ # Documentation directory
│ ├── README.md # Homepage
│ └── guide/ # Guide docs
└── package.jsonWriting Content
Create Markdown files in the docs directory, and VuePress will automatically convert them to web pages.
# My Article
This is the content of an article.
## Subheading
More content...Start Development Server
npm run devVisit http://localhost:8080 to see the result.
Build for Production
npm run buildThe built files are in the docs/.vuepress/dist directory.
Next Steps
- Check out the VuePress official docs
- Try the vuepress-theme-plume theme
- Explore more plugins and components
