Valaxy

🌌 A static blog framework for your voice.

• English | 简体中文
• English Docs | 中文文档
• Theme Press Docs | Theme Press Preview
• Demo: with valaxy-theme-yun

Usage

Try it Online

Init Project Locally

Just run the following command to init your blog:

# pnpm (recommended)
pnpm create valaxy
# npm
# npm init valaxy
# yarn
# yarn create valaxy

For an example, you can see demo/yun folder.

Features

• ⚡️ Vue 3, Vite 8, pnpm, Rolldown - born with fastness
• 🔥 Hot Reload with Config & Markdown
• 🔧 Type Tooltip for all config by valaxy.config.ts
• 🗒 Extended Markdown Frontmatter
• 🗂 File based routing via vue-router
• 📦 Components auto importing via unplugin-vue-components
• 🖨 Static-site generation (SSG) via the built-in Valaxy SSG engine (SPA is OK!)
• 🕸 RSS & Sitemap
• 🎨 Free to use Tailwind CSS via UnoCSS
• 🌍 CSS i18n in One Page
• 🔍 Use icons from any icon sets with classes - Icônes
• 👔 Extended Theme with Layout system
• ⚙️ Unit Testing with Vitest
• ☁️ Deploy zero-config
  • Netlify with netlify.toml
  • GitHub Pages with .github/workflows/gh-pages.yml GitHub Actions
• ♻️ Use any vite plugins
  • 📲 You can implement PWA by vite-plugin-pwa
• ...

AI-ready

• Agent Skills — npx skills add YunYouJun/valaxy
• Local read-only MCP — mcp: true
• llms.txt / Markdown output — llms.enable

Dev

Want to get involved in the development? Look here.

Want to create your theme? Check valaxy-theme-starter.

Thanks

💗 The implementation of Valaxy is based on or refer the following projects:

• Vue
• VueUse
• Vite
• VitePress
• Vitesse
• Slidev

Sponsors

❤️ Special thanks to the following sponsors for their support.

Contributing

Thanks to everyone who has contributed to Valaxy